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

SCardState

関数
スマートカードの現在の状態とATRを取得する。
DLLWinSCard.dll呼出規約winapi

シグネチャ

// WinSCard.dll
#include <windows.h>

INT SCardState(
    UINT_PTR hCard,
    DWORD* pdwState,
    DWORD* pdwProtocol,
    BYTE* pbAtr,
    DWORD* pcbAtrLen
);

パラメーター

名前方向説明
hCardUINT_PTRin状態を取得する対象のカード接続ハンドル。
pdwStateDWORD*outカードの現在状態フラグを受け取る出力ポインタ。
pdwProtocolDWORD*out現在有効な通信プロトコルを受け取る出力ポインタ。
pbAtrBYTE*outカードのATRバイト列を受け取る出力バッファ。
pcbAtrLenDWORD*inoutpbAtrバッファ長を入出力する。実際のATRバイト数が返る。

戻り値の型: INT

各言語での呼び出し定義

// WinSCard.dll
#include <windows.h>

INT SCardState(
    UINT_PTR hCard,
    DWORD* pdwState,
    DWORD* pdwProtocol,
    BYTE* pbAtr,
    DWORD* pcbAtrLen
);
[DllImport("WinSCard.dll", ExactSpelling = true)]
static extern int SCardState(
    UIntPtr hCard,   // UINT_PTR
    out uint pdwState,   // DWORD* out
    out uint pdwProtocol,   // DWORD* out
    IntPtr pbAtr,   // BYTE* out
    ref uint pcbAtrLen   // DWORD* in/out
);
<DllImport("WinSCard.dll", ExactSpelling:=True)>
Public Shared Function SCardState(
    hCard As UIntPtr,   ' UINT_PTR
    <Out> ByRef pdwState As UInteger,   ' DWORD* out
    <Out> ByRef pdwProtocol As UInteger,   ' DWORD* out
    pbAtr As IntPtr,   ' BYTE* out
    ByRef pcbAtrLen As UInteger   ' DWORD* in/out
) As Integer
End Function
' hCard : UINT_PTR
' pdwState : DWORD* out
' pdwProtocol : DWORD* out
' pbAtr : BYTE* out
' pcbAtrLen : DWORD* in/out
Declare PtrSafe Function SCardState Lib "winscard" ( _
    ByVal hCard As LongPtr, _
    ByRef pdwState As Long, _
    ByRef pdwProtocol As Long, _
    ByVal pbAtr As LongPtr, _
    ByRef pcbAtrLen As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SCardState = ctypes.windll.winscard.SCardState
SCardState.restype = ctypes.c_int
SCardState.argtypes = [
    ctypes.c_size_t,  # hCard : UINT_PTR
    ctypes.POINTER(wintypes.DWORD),  # pdwState : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # pdwProtocol : DWORD* out
    ctypes.POINTER(ctypes.c_ubyte),  # pbAtr : BYTE* out
    ctypes.POINTER(wintypes.DWORD),  # pcbAtrLen : DWORD* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WinSCard.dll')
SCardState = Fiddle::Function.new(
  lib['SCardState'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hCard : UINT_PTR
    Fiddle::TYPE_VOIDP,  # pdwState : DWORD* out
    Fiddle::TYPE_VOIDP,  # pdwProtocol : DWORD* out
    Fiddle::TYPE_VOIDP,  # pbAtr : BYTE* out
    Fiddle::TYPE_VOIDP,  # pcbAtrLen : DWORD* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "winscard")]
extern "system" {
    fn SCardState(
        hCard: usize,  // UINT_PTR
        pdwState: *mut u32,  // DWORD* out
        pdwProtocol: *mut u32,  // DWORD* out
        pbAtr: *mut u8,  // BYTE* out
        pcbAtrLen: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WinSCard.dll")]
public static extern int SCardState(UIntPtr hCard, out uint pdwState, out uint pdwProtocol, IntPtr pbAtr, ref uint pcbAtrLen);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WinSCard_SCardState' -Namespace Win32 -PassThru
# $api::SCardState(hCard, pdwState, pdwProtocol, pbAtr, pcbAtrLen)
#uselib "WinSCard.dll"
#func global SCardState "SCardState" sptr, sptr, sptr, sptr, sptr
; SCardState hCard, varptr(pdwState), varptr(pdwProtocol), varptr(pbAtr), varptr(pcbAtrLen)   ; 戻り値は stat
; hCard : UINT_PTR -> "sptr"
; pdwState : DWORD* out -> "sptr"
; pdwProtocol : DWORD* out -> "sptr"
; pbAtr : BYTE* out -> "sptr"
; pcbAtrLen : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WinSCard.dll"
#cfunc global SCardState "SCardState" sptr, var, var, var, var
; res = SCardState(hCard, pdwState, pdwProtocol, pbAtr, pcbAtrLen)
; hCard : UINT_PTR -> "sptr"
; pdwState : DWORD* out -> "var"
; pdwProtocol : DWORD* out -> "var"
; pbAtr : BYTE* out -> "var"
; pcbAtrLen : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT SCardState(UINT_PTR hCard, DWORD* pdwState, DWORD* pdwProtocol, BYTE* pbAtr, DWORD* pcbAtrLen)
#uselib "WinSCard.dll"
#cfunc global SCardState "SCardState" intptr, var, var, var, var
; res = SCardState(hCard, pdwState, pdwProtocol, pbAtr, pcbAtrLen)
; hCard : UINT_PTR -> "intptr"
; pdwState : DWORD* out -> "var"
; pdwProtocol : DWORD* out -> "var"
; pbAtr : BYTE* out -> "var"
; pcbAtrLen : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winscard = windows.NewLazySystemDLL("WinSCard.dll")
	procSCardState = winscard.NewProc("SCardState")
)

// hCard (UINT_PTR), pdwState (DWORD* out), pdwProtocol (DWORD* out), pbAtr (BYTE* out), pcbAtrLen (DWORD* in/out)
r1, _, err := procSCardState.Call(
	uintptr(hCard),
	uintptr(pdwState),
	uintptr(pdwProtocol),
	uintptr(pbAtr),
	uintptr(pcbAtrLen),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function SCardState(
  hCard: NativeUInt;   // UINT_PTR
  pdwState: Pointer;   // DWORD* out
  pdwProtocol: Pointer;   // DWORD* out
  pbAtr: Pointer;   // BYTE* out
  pcbAtrLen: Pointer   // DWORD* in/out
): Integer; stdcall;
  external 'WinSCard.dll' name 'SCardState';
result := DllCall("WinSCard\SCardState"
    , "UPtr", hCard   ; UINT_PTR
    , "Ptr", pdwState   ; DWORD* out
    , "Ptr", pdwProtocol   ; DWORD* out
    , "Ptr", pbAtr   ; BYTE* out
    , "Ptr", pcbAtrLen   ; DWORD* in/out
    , "Int")   ; return: INT
●SCardState(hCard, pdwState, pdwProtocol, pbAtr, pcbAtrLen) = DLL("WinSCard.dll", "int SCardState(int, void*, void*, void*, void*)")
# 呼び出し: SCardState(hCard, pdwState, pdwProtocol, pbAtr, pcbAtrLen)
# hCard : UINT_PTR -> "int"
# pdwState : DWORD* out -> "void*"
# pdwProtocol : DWORD* out -> "void*"
# pbAtr : BYTE* out -> "void*"
# pcbAtrLen : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "winscard" fn SCardState(
    hCard: usize, // UINT_PTR
    pdwState: [*c]u32, // DWORD* out
    pdwProtocol: [*c]u32, // DWORD* out
    pbAtr: [*c]u8, // BYTE* out
    pcbAtrLen: [*c]u32 // DWORD* in/out
) callconv(std.os.windows.WINAPI) i32;
proc SCardState(
    hCard: uint,  # UINT_PTR
    pdwState: ptr uint32,  # DWORD* out
    pdwProtocol: ptr uint32,  # DWORD* out
    pbAtr: ptr uint8,  # BYTE* out
    pcbAtrLen: ptr uint32  # DWORD* in/out
): int32 {.importc: "SCardState", stdcall, dynlib: "WinSCard.dll".}
pragma(lib, "winscard");
extern(Windows)
int SCardState(
    size_t hCard,   // UINT_PTR
    uint* pdwState,   // DWORD* out
    uint* pdwProtocol,   // DWORD* out
    ubyte* pbAtr,   // BYTE* out
    uint* pcbAtrLen   // DWORD* in/out
);
ccall((:SCardState, "WinSCard.dll"), stdcall, Int32,
      (Csize_t, Ptr{UInt32}, Ptr{UInt32}, Ptr{UInt8}, Ptr{UInt32}),
      hCard, pdwState, pdwProtocol, pbAtr, pcbAtrLen)
# hCard : UINT_PTR -> Csize_t
# pdwState : DWORD* out -> Ptr{UInt32}
# pdwProtocol : DWORD* out -> Ptr{UInt32}
# pbAtr : BYTE* out -> Ptr{UInt8}
# pcbAtrLen : DWORD* in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SCardState(
    uintptr_t hCard,
    uint32_t* pdwState,
    uint32_t* pdwProtocol,
    uint8_t* pbAtr,
    uint32_t* pcbAtrLen);
]]
local winscard = ffi.load("winscard")
-- winscard.SCardState(hCard, pdwState, pdwProtocol, pbAtr, pcbAtrLen)
-- hCard : UINT_PTR
-- pdwState : DWORD* out
-- pdwProtocol : DWORD* out
-- pbAtr : BYTE* out
-- pcbAtrLen : DWORD* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WinSCard.dll');
const SCardState = lib.func('__stdcall', 'SCardState', 'int32_t', ['uintptr_t', 'uint32_t *', 'uint32_t *', 'uint8_t *', 'uint32_t *']);
// SCardState(hCard, pdwState, pdwProtocol, pbAtr, pcbAtrLen)
// hCard : UINT_PTR -> 'uintptr_t'
// pdwState : DWORD* out -> 'uint32_t *'
// pdwProtocol : DWORD* out -> 'uint32_t *'
// pbAtr : BYTE* out -> 'uint8_t *'
// pcbAtrLen : DWORD* in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WinSCard.dll", {
  SCardState: { parameters: ["usize", "pointer", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.SCardState(hCard, pdwState, pdwProtocol, pbAtr, pcbAtrLen)
// hCard : UINT_PTR -> "usize"
// pdwState : DWORD* out -> "pointer"
// pdwProtocol : DWORD* out -> "pointer"
// pbAtr : BYTE* out -> "pointer"
// pcbAtrLen : DWORD* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SCardState(
    size_t hCard,
    uint32_t* pdwState,
    uint32_t* pdwProtocol,
    uint8_t* pbAtr,
    uint32_t* pcbAtrLen);
C, "WinSCard.dll");
// $ffi->SCardState(hCard, pdwState, pdwProtocol, pbAtr, pcbAtrLen);
// hCard : UINT_PTR
// pdwState : DWORD* out
// pdwProtocol : DWORD* out
// pbAtr : BYTE* out
// pcbAtrLen : DWORD* in/out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Winscard extends StdCallLibrary {
    Winscard INSTANCE = Native.load("winscard", Winscard.class);
    int SCardState(
        long hCard,   // UINT_PTR
        IntByReference pdwState,   // DWORD* out
        IntByReference pdwProtocol,   // DWORD* out
        byte[] pbAtr,   // BYTE* out
        IntByReference pcbAtrLen   // DWORD* in/out
    );
}
@[Link("winscard")]
lib LibWinSCard
  fun SCardState = SCardState(
    hCard : LibC::SizeT,   # UINT_PTR
    pdwState : UInt32*,   # DWORD* out
    pdwProtocol : UInt32*,   # DWORD* out
    pbAtr : UInt8*,   # BYTE* out
    pcbAtrLen : UInt32*   # DWORD* in/out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SCardStateNative = Int32 Function(UintPtr, Pointer<Uint32>, Pointer<Uint32>, Pointer<Uint8>, Pointer<Uint32>);
typedef SCardStateDart = int Function(int, Pointer<Uint32>, Pointer<Uint32>, Pointer<Uint8>, Pointer<Uint32>);
final SCardState = DynamicLibrary.open('WinSCard.dll')
    .lookupFunction<SCardStateNative, SCardStateDart>('SCardState');
// hCard : UINT_PTR -> UintPtr
// pdwState : DWORD* out -> Pointer<Uint32>
// pdwProtocol : DWORD* out -> Pointer<Uint32>
// pbAtr : BYTE* out -> Pointer<Uint8>
// pcbAtrLen : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SCardState(
  hCard: NativeUInt;   // UINT_PTR
  pdwState: Pointer;   // DWORD* out
  pdwProtocol: Pointer;   // DWORD* out
  pbAtr: Pointer;   // BYTE* out
  pcbAtrLen: Pointer   // DWORD* in/out
): Integer; stdcall;
  external 'WinSCard.dll' name 'SCardState';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SCardState"
  c_SCardState :: CUIntPtr -> Ptr Word32 -> Ptr Word32 -> Ptr Word8 -> Ptr Word32 -> IO Int32
-- hCard : UINT_PTR -> CUIntPtr
-- pdwState : DWORD* out -> Ptr Word32
-- pdwProtocol : DWORD* out -> Ptr Word32
-- pbAtr : BYTE* out -> Ptr Word8
-- pcbAtrLen : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let scardstate =
  foreign "SCardState"
    (size_t @-> (ptr uint32_t) @-> (ptr uint32_t) @-> (ptr uint8_t) @-> (ptr uint32_t) @-> returning int32_t)
(* hCard : UINT_PTR -> size_t *)
(* pdwState : DWORD* out -> (ptr uint32_t) *)
(* pdwProtocol : DWORD* out -> (ptr uint32_t) *)
(* pbAtr : BYTE* out -> (ptr uint8_t) *)
(* pcbAtrLen : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winscard (t "WinSCard.dll"))
(cffi:use-foreign-library winscard)

(cffi:defcfun ("SCardState" scard-state :convention :stdcall) :int32
  (h-card :uint64)   ; UINT_PTR
  (pdw-state :pointer)   ; DWORD* out
  (pdw-protocol :pointer)   ; DWORD* out
  (pb-atr :pointer)   ; BYTE* out
  (pcb-atr-len :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SCardState = Win32::API::More->new('WinSCard',
    'int SCardState(WPARAM hCard, LPVOID pdwState, LPVOID pdwProtocol, LPVOID pbAtr, LPVOID pcbAtrLen)');
# my $ret = $SCardState->Call($hCard, $pdwState, $pdwProtocol, $pbAtr, $pcbAtrLen);
# hCard : UINT_PTR -> WPARAM
# pdwState : DWORD* out -> LPVOID
# pdwProtocol : DWORD* out -> LPVOID
# pbAtr : BYTE* out -> LPVOID
# pcbAtrLen : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。