ホーム › Security.Credentials › SCardLocateCardsByATRA

SCardLocateCardsByATRA

関数

ATRマスクに一致するカードをリーダーから検索する。

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

シグネチャ

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

INT SCardLocateCardsByATRA(
    UINT_PTR hContext,
    SCARD_ATRMASK* rgAtrMasks,
    DWORD cAtrs,
    SCARD_READERSTATEA* rgReaderStates,
    DWORD cReaders
);

パラメーター

名前	型	方向	説明
hContext	UINT_PTR	in	リソースマネージャーコンテキストを識別するハンドル。リソースマネージャーコンテキストは、事前の SCardEstablishContext の呼び出しによって設定されます。
rgAtrMasks	SCARD_ATRMASK*	in	検索対象のカード名を含む SCARD_ATRMASK 構造体の配列。
cAtrs	DWORD	in	rgAtrMasks 配列の要素数。
rgReaderStates	SCARD_READERSTATEA*	inout	検索対象のリーダーを指定し、結果を受け取る SCARD_READERSTATE 構造体の配列。
cReaders	DWORD	in	rgReaderStates 配列の要素数。

戻り値の型: INT

公式ドキュメント

rgReaderStates パラメーターで指定されたリーダーを検索し、rgAtrMasks パラメーターで指定された SCARD_ATRMASK 構造体に含まれるいずれかのカード名と一致する名前を持つカードを探します。(ANSI)

戻り値

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

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

解説(Remarks)

このサービスは、 SCardGetStatusChange と組み合わせて使用すると特に便利です。SCardLocateCards によって一致するカードが見つからなかった場合、呼び出し元のアプリケーションは SCardGetStatusChange を使用してカードの可用性の変化を待機できます。

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

メモ

winscard.h ヘッダーは、SCardLocateCardsByATR を、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 SCardLocateCardsByATRA(
    UINT_PTR hContext,
    SCARD_ATRMASK* rgAtrMasks,
    DWORD cAtrs,
    SCARD_READERSTATEA* rgReaderStates,
    DWORD cReaders
);

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

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

' hContext : UINT_PTR
' rgAtrMasks : SCARD_ATRMASK*
' cAtrs : DWORD
' rgReaderStates : SCARD_READERSTATEA* in/out
' cReaders : DWORD
Declare PtrSafe Function SCardLocateCardsByATRA Lib "winscard" ( _
    ByVal hContext As LongPtr, _
    ByVal rgAtrMasks As LongPtr, _
    ByVal cAtrs 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

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

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "winscard")]
extern "system" {
    fn SCardLocateCardsByATRA(
        hContext: usize,  // UINT_PTR
        rgAtrMasks: *mut SCARD_ATRMASK,  // SCARD_ATRMASK*
        cAtrs: 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 SCardLocateCardsByATRA(UIntPtr hContext, IntPtr rgAtrMasks, uint cAtrs, IntPtr rgReaderStates, uint cReaders);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WinSCard_SCardLocateCardsByATRA' -Namespace Win32 -PassThru
# $api::SCardLocateCardsByATRA(hContext, rgAtrMasks, cAtrs, rgReaderStates, cReaders)

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

出力引数:

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