ホーム › Security.Credentials › SCardGetStatusChangeA

SCardGetStatusChangeA

関数

リーダー状態の変化をタイムアウト付きで待機する。

DLLWinSCard.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降

シグネチャ

// WinSCard.dll  (ANSI / -A)
#include <windows.h>

INT SCardGetStatusChangeA(
    UINT_PTR hContext,
    DWORD dwTimeout,
    SCARD_READERSTATEA* rgReaderStates,
    DWORD cReaders
);

パラメーター

名前	型	方向	説明
hContext	UINT_PTR	in	リソースマネージャーコンテキストを識別するハンドルです。リソースマネージャーコンテキストは、事前に SCardEstablishContext 関数を呼び出すことで設定されます。
dwTimeout	DWORD	in	アクションを待機する最大時間(ミリ秒単位)です。値が 0 の場合、この関数は即座に戻ります。値が INFINITE の場合、この関数はタイムアウトしません。
rgReaderStates	SCARD_READERSTATEA*	inout	監視対象のリーダーを指定し、結果を受け取る SCARD_READERSTATE 構造体の配列です。新しいスマートカードリーダーの追加を通知するには、SCARD_READERSTATE 構造体の szReader メンバーを "\\?PnP?\Notification" に設定し、その構造体の他のすべてのメンバーを 0 に設定します。重要この配列内の各構造体の各メンバーは、まず 0 に初期化し、その後で必要に応じて特定の値を設定する必要があります。これを行わないと、リモートカードリーダーが関係する状況で関数が失敗します。
cReaders	DWORD	in	rgReaderStates 配列内の要素数です。

戻り値の型: INT

公式ドキュメント

特定のリーダーのセットにあるカードの現在の利用可能状態が変化するまで、実行をブロックします。(ANSI)

戻り値

この関数は、成功するか失敗するかに応じて異なる値を返します。

戻りコード	説明
成功	SCARD_S_SUCCESS。
失敗	エラーコード。詳細については、 Smart Card Return Values を参照してください。

解説(Remarks)

SCardGetStatusChange 関数は、スマートカードの追跡関数です。その他の追跡関数の詳細については、 Smart Card Tracking Functions を参照してください。

例

この関数の呼び出し方法については、 SCardLocateCards の例を参照してください。

メモ

winscard.h ヘッダーは、SCardGetStatusChange を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じてコンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// WinSCard.dll  (ANSI / -A)
#include <windows.h>

INT SCardGetStatusChangeA(
    UINT_PTR hContext,
    DWORD dwTimeout,
    SCARD_READERSTATEA* rgReaderStates,
    DWORD cReaders
);

[DllImport("WinSCard.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int SCardGetStatusChangeA(
    UIntPtr hContext,   // UINT_PTR
    uint dwTimeout,   // DWORD
    IntPtr rgReaderStates,   // SCARD_READERSTATEA* in/out
    uint cReaders   // DWORD
);

<DllImport("WinSCard.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SCardGetStatusChangeA(
    hContext As UIntPtr,   ' UINT_PTR
    dwTimeout As UInteger,   ' DWORD
    rgReaderStates As IntPtr,   ' SCARD_READERSTATEA* in/out
    cReaders As UInteger   ' DWORD
) As Integer
End Function

' hContext : UINT_PTR
' dwTimeout : DWORD
' rgReaderStates : SCARD_READERSTATEA* in/out
' cReaders : DWORD
Declare PtrSafe Function SCardGetStatusChangeA Lib "winscard" ( _
    ByVal hContext As LongPtr, _
    ByVal dwTimeout As Long, _
    ByVal rgReaderStates As LongPtr, _
    ByVal cReaders As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SCardGetStatusChangeA = ctypes.windll.winscard.SCardGetStatusChangeA
SCardGetStatusChangeA.restype = ctypes.c_int
SCardGetStatusChangeA.argtypes = [
    ctypes.c_size_t,  # hContext : UINT_PTR
    wintypes.DWORD,  # dwTimeout : DWORD
    ctypes.c_void_p,  # rgReaderStates : SCARD_READERSTATEA* in/out
    wintypes.DWORD,  # cReaders : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WinSCard.dll')
SCardGetStatusChangeA = Fiddle::Function.new(
  lib['SCardGetStatusChangeA'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hContext : UINT_PTR
    -Fiddle::TYPE_INT,  # dwTimeout : DWORD
    Fiddle::TYPE_VOIDP,  # rgReaderStates : SCARD_READERSTATEA* in/out
    -Fiddle::TYPE_INT,  # cReaders : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "winscard")]
extern "system" {
    fn SCardGetStatusChangeA(
        hContext: usize,  // UINT_PTR
        dwTimeout: u32,  // DWORD
        rgReaderStates: *mut SCARD_READERSTATEA,  // SCARD_READERSTATEA* in/out
        cReaders: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WinSCard.dll", CharSet = CharSet.Ansi)]
public static extern int SCardGetStatusChangeA(UIntPtr hContext, uint dwTimeout, IntPtr rgReaderStates, uint cReaders);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WinSCard_SCardGetStatusChangeA' -Namespace Win32 -PassThru
# $api::SCardGetStatusChangeA(hContext, dwTimeout, rgReaderStates, cReaders)

#uselib "WinSCard.dll"
#func global SCardGetStatusChangeA "SCardGetStatusChangeA" sptr, sptr, sptr, sptr
; SCardGetStatusChangeA hContext, dwTimeout, varptr(rgReaderStates), cReaders   ; 戻り値は stat
; hContext : UINT_PTR -> "sptr"
; dwTimeout : DWORD -> "sptr"
; rgReaderStates : SCARD_READERSTATEA* in/out -> "sptr"
; cReaders : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WinSCard.dll"
#cfunc global SCardGetStatusChangeA "SCardGetStatusChangeA" sptr, int, var, int
; res = SCardGetStatusChangeA(hContext, dwTimeout, rgReaderStates, cReaders)
; hContext : UINT_PTR -> "sptr"
; dwTimeout : DWORD -> "int"
; rgReaderStates : SCARD_READERSTATEA* in/out -> "var"
; cReaders : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WinSCard.dll"
#cfunc global SCardGetStatusChangeA "SCardGetStatusChangeA" sptr, int, sptr, int
; res = SCardGetStatusChangeA(hContext, dwTimeout, varptr(rgReaderStates), cReaders)
; hContext : UINT_PTR -> "sptr"
; dwTimeout : DWORD -> "int"
; rgReaderStates : SCARD_READERSTATEA* in/out -> "sptr"
; cReaders : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。