ホーム › Security.Credentials › SCardLocateCardsA

SCardLocateCardsA

関数

指定カードが挿入されたリーダーの状態を取得する。

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

シグネチャ

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

INT SCardLocateCardsA(
    UINT_PTR hContext,
    LPCSTR mszCards,
    SCARD_READERSTATEA* rgReaderStates,
    DWORD cReaders
);

パラメーター

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

戻り値の型: INT

公式ドキュメント

rgReaderStates パラメーターに列挙されたリーダーを検索し、mszCards で指定されたカード名のいずれかと一致する ATR 文字列を持つカードを探して、結果を即座に返します。(ANSI)

戻り値

この関数は、成功した場合と失敗した場合とで異なる値を返します。

戻り値	説明
成功	SCARD_S_SUCCESS。
失敗	エラーコード。詳細については、スマートカードの戻り値を参照してください。

解説(Remarks)

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

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

この関数の呼び出しは、トランザクションの外で行う必要があります。アプリケーションが SCardBeginTransaction 関数でトランザクションを開始した後にこの関数を呼び出すと、SCardBeginTransaction 関数の hCard パラメーター(SCARDHANDLE 型)がリセットされます。

Windows Server 2008 R2 および Windows 7: トランザクション内でこの関数を呼び出すと、コンピューターが応答しなくなる可能性があります。

Windows Server 2008、Windows Vista、Windows Server 2003 および Windows XP: 該当しません。

例

次の例は、スマートカードを検索する方法を示しています。

// Copyright (C) Microsoft. All rights reserved. 
#include <stdio.h>
#include <winscard.h>
#include <tchar.h>
#pragma comment(lib, "winscard.lib")

HRESULT __cdecl main()
{
HRESULT           hr = S_OK;
LPTSTR            szReaders, szRdr;
DWORD             cchReaders = SCARD_AUTOALLOCATE;
DWORD             dwI, dwRdrCount;
SCARD_READERSTATE rgscState[MAXIMUM_SMARTCARD_READERS];
TCHAR             szCard[MAX_PATH];
SCARDCONTEXT      hSC;
LONG              lReturn;

// Establish the card to watch for.
// Multiple cards can be looked for, but
// this sample looks for only one card.
_tcscat_s ( szCard, MAX_PATH * sizeof(TCHAR), TEXT("GemSAFE"));
szCard[lstrlen(szCard) + 1] = 0;  // Double trailing zero.

// Establish a context.
lReturn = SCardEstablishContext(SCARD_SCOPE_USER,
                                NULL,
                                NULL,
                                &hSC );
if ( SCARD_S_SUCCESS != lReturn )
{
    printf("Failed SCardEstablishContext\n");
    exit(1);
}

// Determine which readers are available.
lReturn = SCardListReaders(hSC,
                           NULL,
                           (LPTSTR)&szReaders,
                           &cchReaders );
if ( SCARD_S_SUCCESS != lReturn )
{
    printf("Failed SCardListReaders\n");
    exit(1);
}
// Place the readers into the state array.
szRdr = szReaders;
for ( dwI = 0; dwI < MAXIMUM_SMARTCARD_READERS; dwI++ )
{
    if ( 0 == *szRdr )
        break;
    rgscState[dwI].szReader = szRdr;
    rgscState[dwI].dwCurrentState = SCARD_STATE_UNAWARE;
    szRdr += lstrlen(szRdr) + 1;
}
dwRdrCount = dwI;

// If any readers are available, proceed.
if ( 0 != dwRdrCount )
{
  for (;;)
  { 
    // Look for the card.
    lReturn = SCardLocateCards(hSC,
                               szCard,
                               rgscState,
                               dwRdrCount );
    if ( SCARD_S_SUCCESS != lReturn )
    {
        printf("Failed SCardLocateCards\n");
        exit(1);
    }

    // Look through the array of readers.
    for ( dwI=0; dwI < dwRdrCount; dwI++)
    {
        if ( 0 != ( SCARD_STATE_ATRMATCH & 
                    rgscState[dwI].dwEventState))
        {
           _tprintf( TEXT("Card '%s' found in reader '%s'.\n"),
                     szCard,
                     rgscState[dwI].szReader );
            SCardFreeMemory( hSC,
                             szReaders );
            return 0;  // Context will be release automatically.
        }
        // Update the state.
        rgscState[dwI].dwCurrentState = rgscState[dwI].dwEventState;
    }

  // Card not found yet; wait until there is a change.
  lReturn = SCardGetStatusChange(hSC,
                                 INFINITE, // infinite wait
                                 rgscState,
                                 dwRdrCount );
  if ( SCARD_S_SUCCESS != lReturn )
  {
    printf("Failed SCardGetStatusChange\n");
    exit(1);
  }
 }  // for (;;)
}
else
    printf("No readers available\n");

// Release the context.
lReturn = SCardReleaseContext(hSC);
if ( SCARD_S_SUCCESS != lReturn )
{
    printf("Failed SCardReleaseContext\n");
    exit(1);
}

SCardFreeMemory( hSC,
                 szReaders );

return hr;
}

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SCardLocateCardsA(
    UINT_PTR hContext,
    LPCSTR mszCards,
    SCARD_READERSTATEA* rgReaderStates,
    DWORD cReaders
);

[DllImport("WinSCard.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int SCardLocateCardsA(
    UIntPtr hContext,   // UINT_PTR
    [MarshalAs(UnmanagedType.LPStr)] string mszCards,   // LPCSTR
    IntPtr rgReaderStates,   // SCARD_READERSTATEA* in/out
    uint cReaders   // DWORD
);

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

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

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

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "winscard")]
extern "system" {
    fn SCardLocateCardsA(
        hContext: usize,  // UINT_PTR
        mszCards: *const u8,  // LPCSTR
        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 SCardLocateCardsA(UIntPtr hContext, [MarshalAs(UnmanagedType.LPStr)] string mszCards, IntPtr rgReaderStates, uint cReaders);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WinSCard_SCardLocateCardsA' -Namespace Win32 -PassThru
# $api::SCardLocateCardsA(hContext, mszCards, rgReaderStates, cReaders)

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

出力引数:

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