Win32 API 日本語リファレンス
ホームSecurity.Credentials › SCARD_READERSTATEW

SCARD_READERSTATEW

構造体
サイズx64: 64 バイト / x86: 56 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
szReaderLPWSTR8/4+0+0

監視対象のリーダー名へのポインターです。

新しいスマートカードリーダーの接続を通知させるには、このメンバーの値を "\\?PnP?\Notification" に設定し、他のすべてのメンバーの値を 0 に設定します。

pvUserDatavoid*8/4+8+4スマートカードサブシステムでは使用されません。このメンバーはアプリケーションが使用します。
dwCurrentStateSCARD_STATE4+16+8

アプリケーションから見たリーダーの現在の状態です。このフィールドには、次の値をビットマスクとして組み合わせて指定できます。

意味
SCARD_STATE_UNAWARE
アプリケーションは現在の状態を認識しておらず、それを知りたいことを示します。この値を使用すると、状態遷移の監視サービスから直ちに制御が戻ります。これはすべてのビットが 0 に設定されていることで表されます。
SCARD_STATE_IGNORE
アプリケーションはこのリーダーに関心がなく、監視操作の対象としないことを示します。このビットが設定されている場合、他のすべてのビットは無視されます。
SCARD_STATE_UNAVAILABLE
アプリケーションは、このリーダーが使用できないと想定しています。このビットが設定されている場合、以降のすべてのビットは無視されます。
SCARD_STATE_EMPTY
アプリケーションは、リーダーにカードが挿入されていないと想定しています。このビットが設定されている場合、以降のすべてのビットは無視されます。
SCARD_STATE_PRESENT
アプリケーションは、リーダーにカードが挿入されていると想定しています。
SCARD_STATE_ATRMATCH
アプリケーションは、対象カードのいずれかと一致する ATR を持つカードがリーダーに挿入されていると想定しています。このビットが設定されている場合、SCARD_STATE_PRESENT が想定されます。このビットは SCardGetStatusChange にとって SCARD_STATE_PRESENT を超える意味を持ちません。
SCARD_STATE_EXCLUSIVE
アプリケーションは、リーダー内のカードが別のアプリケーションによる排他使用のために割り当てられていると想定しています。このビットが設定されている場合、SCARD_STATE_PRESENT が想定されます。
SCARD_STATE_INUSE
アプリケーションは、リーダー内のカードが 1 つ以上の他のアプリケーションによって使用されているものの、共有モードで接続できると想定しています。このビットが設定されている場合、SCARD_STATE_PRESENT が想定されます。
SCARD_STATE_MUTE
アプリケーションは、応答しないカードがリーダーに挿入されていると想定しています。
SCARD_STATE_UNPOWERED
リーダー内のカードに電源が投入されていないことを示します。
dwEventStateSCARD_STATE4+20+12

スマートカードリソースマネージャーが把握しているリーダーの現在の状態です。このフィールドには、次の値をビットマスクとして組み合わせて指定できます。

意味
SCARD_STATE_IGNORE
このリーダーは無視する必要があります。
SCARD_STATE_CHANGED
アプリケーションが認識している状態と、リソースマネージャーが把握している状態との間に差異があります。このビットが設定されている場合、アプリケーションはこのリーダーで重要な状態変化が発生したと見なすことができます。
SCARD_STATE_UNKNOWN
指定されたリーダー名がリソースマネージャーで認識されていません。このビットが設定されている場合、SCARD_STATE_CHANGEDSCARD_STATE_IGNORE も設定されます。
SCARD_STATE_UNAVAILABLE
このリーダーの実際の状態は取得できません。このビットが設定されている場合、以降のすべてのビットはクリアされます。
SCARD_STATE_EMPTY
リーダーにカードが挿入されていません。このビットが設定されている場合、以降のすべてのビットはクリアされます。
SCARD_STATE_PRESENT
リーダーにカードが挿入されています。
SCARD_STATE_ATRMATCH
対象カードのいずれかと一致する ATR を持つカードがリーダーに挿入されています。このビットが設定されている場合、SCARD_STATE_PRESENT も設定されます。このビットは SCardLocateCards 関数でのみ返されます。
SCARD_STATE_EXCLUSIVE
リーダー内のカードは、別のアプリケーションによる排他使用のために割り当てられています。このビットが設定されている場合、SCARD_STATE_PRESENT も設定されます。
SCARD_STATE_INUSE
リーダー内のカードは 1 つ以上の他のアプリケーションによって使用されていますが、共有モードで接続できます。このビットが設定されている場合、SCARD_STATE_PRESENT も設定されます。
SCARD_STATE_MUTE
応答しないカードがリーダーに挿入されています。
SCARD_STATE_UNPOWERED
リーダー内のカードに電源が投入されていないことを示します。
cbAtrDWORD4+24+16返される ATR のバイト数です。
rgbAtrBYTE36+28+20挿入されたカードの ATR です。余分な位置合わせ用のバイトが付加されます。

公式ドキュメント

SCARD_READERSTATE 構造体は、リーダー内のスマートカードを追跡する関数で使用されます。

解説(Remarks)

メモ

winscard.h ヘッダーは、UNICODE プリプロセッサ定数の定義に応じてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SCARD_READERSTATE を定義します。エンコーディング中立のエイリアスを、エンコーディング中立でないコードと混在させて使用すると、不一致が生じ、コンパイルエラーや実行時エラーの原因となる場合があります。詳細については、関数プロトタイプの規則 を参照してください。

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

各言語での定義

#include <windows.h>

// SCARD_READERSTATEW  (x64 64 / x86 56 バイト)
typedef struct SCARD_READERSTATEW {
    LPWSTR szReader;
    void* pvUserData;
    SCARD_STATE dwCurrentState;
    SCARD_STATE dwEventState;
    DWORD cbAtr;
    BYTE rgbAtr[36];
} SCARD_READERSTATEW;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct SCARD_READERSTATEW
{
    public IntPtr szReader;
    public IntPtr pvUserData;
    public uint dwCurrentState;
    public uint dwEventState;
    public uint cbAtr;
    [MarshalAs(UnmanagedType.ByValArray, SizeConst = 36)] public byte[] rgbAtr;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure SCARD_READERSTATEW
    Public szReader As IntPtr
    Public pvUserData As IntPtr
    Public dwCurrentState As UInteger
    Public dwEventState As UInteger
    Public cbAtr As UInteger
    <MarshalAs(UnmanagedType.ByValArray, SizeConst:=36)> Public rgbAtr() As Byte
End Structure
import ctypes
from ctypes import wintypes

class SCARD_READERSTATEW(ctypes.Structure):
    _fields_ = [
        ("szReader", ctypes.c_void_p),
        ("pvUserData", ctypes.c_void_p),
        ("dwCurrentState", wintypes.DWORD),
        ("dwEventState", wintypes.DWORD),
        ("cbAtr", wintypes.DWORD),
        ("rgbAtr", ctypes.c_ubyte * 36),
    ]
#[repr(C)]
pub struct SCARD_READERSTATEW {
    pub szReader: *mut core::ffi::c_void,
    pub pvUserData: *mut core::ffi::c_void,
    pub dwCurrentState: u32,
    pub dwEventState: u32,
    pub cbAtr: u32,
    pub rgbAtr: [u8; 36],
}
import "golang.org/x/sys/windows"

type SCARD_READERSTATEW struct {
	szReader uintptr
	pvUserData uintptr
	dwCurrentState uint32
	dwEventState uint32
	cbAtr uint32
	rgbAtr [36]byte
}
type
  SCARD_READERSTATEW = record
    szReader: Pointer;
    pvUserData: Pointer;
    dwCurrentState: DWORD;
    dwEventState: DWORD;
    cbAtr: DWORD;
    rgbAtr: array[0..35] of Byte;
  end;
const SCARD_READERSTATEW = extern struct {
    szReader: ?*anyopaque,
    pvUserData: ?*anyopaque,
    dwCurrentState: u32,
    dwEventState: u32,
    cbAtr: u32,
    rgbAtr: [36]u8,
};
type
  SCARD_READERSTATEW {.bycopy.} = object
    szReader: pointer
    pvUserData: pointer
    dwCurrentState: uint32
    dwEventState: uint32
    cbAtr: uint32
    rgbAtr: array[36, uint8]
struct SCARD_READERSTATEW
{
    void* szReader;
    void* pvUserData;
    uint dwCurrentState;
    uint dwEventState;
    uint cbAtr;
    ubyte[36] rgbAtr;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; SCARD_READERSTATEW サイズ: 56 バイト(x86)
dim st, 14    ; 4byte整数×14(構造体サイズ 56 / 4 切り上げ)
; szReader : LPWSTR (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; pvUserData : void* (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; dwCurrentState : SCARD_STATE (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; dwEventState : SCARD_STATE (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; cbAtr : DWORD (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; rgbAtr : BYTE (+20, 36byte)  varptr(st)+20 を基点に操作(36byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; SCARD_READERSTATEW サイズ: 64 バイト(x64)
dim st, 16    ; 4byte整数×16(構造体サイズ 64 / 4 切り上げ)
; szReader : LPWSTR (+0, 8byte)  qpoke st,0,値 / qpeek(st,0)  ※IronHSPのみ。3.7/3.8は lpoke st,0,下位 : lpoke st,4,上位
; pvUserData : void* (+8, 8byte)  qpoke st,8,値 / qpeek(st,8)  ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; dwCurrentState : SCARD_STATE (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; dwEventState : SCARD_STATE (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; cbAtr : DWORD (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; rgbAtr : BYTE (+28, 36byte)  varptr(st)+28 を基点に操作(36byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global SCARD_READERSTATEW
    #field intptr szReader
    #field intptr pvUserData
    #field int dwCurrentState
    #field int dwEventState
    #field int cbAtr
    #field byte rgbAtr 36
#endstruct

stdim st, SCARD_READERSTATEW        ; NSTRUCT 変数を確保
st->dwCurrentState = 100
mes "dwCurrentState=" + st->dwCurrentState