ホーム › Security.Credentials › SCardLocateCardsW

SCardLocateCardsW

関数

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

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

シグネチャ

// WinSCard.dll  (Unicode / -W)
#include <windows.h>

INT SCardLocateCardsW(
    UINT_PTR hContext,
    LPCWSTR mszCards,
    SCARD_READERSTATEW* rgReaderStates,
    DWORD cReaders
);

パラメーター

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

戻り値の型: INT

公式ドキュメント

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

戻り値

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

Return code	Description
成功	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  (Unicode / -W)
#include <windows.h>

INT SCardLocateCardsW(
    UINT_PTR hContext,
    LPCWSTR mszCards,
    SCARD_READERSTATEW* rgReaderStates,
    DWORD cReaders
);

[DllImport("WinSCard.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int SCardLocateCardsW(
    UIntPtr hContext,   // UINT_PTR
    [MarshalAs(UnmanagedType.LPWStr)] string mszCards,   // LPCWSTR
    IntPtr rgReaderStates,   // SCARD_READERSTATEW* in/out
    uint cReaders   // DWORD
);

<DllImport("WinSCard.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SCardLocateCardsW(
    hContext As UIntPtr,   ' UINT_PTR
    <MarshalAs(UnmanagedType.LPWStr)> mszCards As String,   ' LPCWSTR
    rgReaderStates As IntPtr,   ' SCARD_READERSTATEW* in/out
    cReaders As UInteger   ' DWORD
) As Integer
End Function

' hContext : UINT_PTR
' mszCards : LPCWSTR
' rgReaderStates : SCARD_READERSTATEW* in/out
' cReaders : DWORD
Declare PtrSafe Function SCardLocateCardsW Lib "winscard" ( _
    ByVal hContext As LongPtr, _
    ByVal mszCards As LongPtr, _
    ByVal rgReaderStates As LongPtr, _
    ByVal cReaders As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WinSCard.dll')
SCardLocateCardsW = Fiddle::Function.new(
  lib['SCardLocateCardsW'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hContext : UINT_PTR
    Fiddle::TYPE_VOIDP,  # mszCards : LPCWSTR
    Fiddle::TYPE_VOIDP,  # rgReaderStates : SCARD_READERSTATEW* in/out
    -Fiddle::TYPE_INT,  # cReaders : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

$sig = @"
[DllImport("WinSCard.dll", CharSet = CharSet.Unicode)]
public static extern int SCardLocateCardsW(UIntPtr hContext, [MarshalAs(UnmanagedType.LPWStr)] string mszCards, IntPtr rgReaderStates, uint cReaders);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WinSCard_SCardLocateCardsW' -Namespace Win32 -PassThru
# $api::SCardLocateCardsW(hContext, mszCards, rgReaderStates, cReaders)

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

出力引数:

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