ホーム › Security.Credentials › SCardListCardsW

SCardListCardsW

関数

ATRやインターフェイスに一致するカード名を列挙する。

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

シグネチャ

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

INT SCardListCardsW(
    UINT_PTR hContext,
    BYTE* pbAtr,   // optional
    const GUID* rgquidInterfaces,   // optional
    DWORD cguidInterfaceCount,
    LPWSTR mszCards,   // optional
    DWORD* pcchCards
);

パラメーター

名前	型	方向	説明
hContext	UINT_PTR	in	クエリのリソースマネージャーコンテキストを識別するハンドルです。リソースマネージャーコンテキストは、以前の SCardEstablishContext の呼び出しによって設定できます。このパラメーターが NULL に設定されている場合、カードの検索は特定のコンテキストに限定されません。
pbAtr	BYTE*	inoptional	既知のカードと比較する ATR 文字列のアドレスです。ATR の照合を行わない場合は NULL を指定します。
rgquidInterfaces	GUID*	inoptional	識別子(GUID)の配列です。インターフェイスの照合を行わない場合は NULL を指定します。配列を指定した場合、指定されたすべての識別子をカードがサポートしている場合にのみカード名が返されます。
cguidInterfaceCount	DWORD	in	rgguidInterfaces 配列のエントリ数です。rgguidInterfaces が NULL の場合、この値は無視されます。
mszCards	LPWSTR	outoptional	見つかったスマートカードを列挙するマルチ文字列です。この値が NULL の場合、SCardListCards は pcchCards で指定されたバッファー長を無視し、このパラメーターが NULL でなかった場合に返されたであろうバッファーの長さを pcchCards に返し、成功コードを返します。
pcchCards	DWORD*	inout	mszCards バッファーの長さ(文字数)です。末尾のすべての null 文字を含む、マルチ文字列構造の実際の長さを受け取ります。バッファー長として SCARD_AUTOALLOCATE が指定された場合、mszCards はバイトポインターへのポインターに変換され、マルチ文字列構造を含むメモリブロックのアドレスを受け取ります。このメモリブロックは SCardFreeMemory で解放する必要があります。

戻り値の型: INT

公式ドキュメント

スマートカードデータベースを検索し、ユーザーによって以前にシステムに登録された名前付きカードの一覧を提供します。(Unicode)

戻り値

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

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

解説(Remarks)

この関数はリダイレクトされませんが、リモートデスクトップセッション内でこの関数を呼び出してもエラーにはなりません。その場合、結果はローカルコンピューターではなくリモートコンピューターのものになるだけです。

サブシステムに登録されたすべてのスマートカードを返すには、pbAtr と rgguidInterfaces を NULL に設定します。

SCardListCards 関数はデータベースクエリ関数です。その他のデータベースクエリ関数の詳細については、 Smart Card Database Query Functions を参照してください。

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

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

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

例

次の例は、スマートカードの一覧表示を示しています。

LPTSTR pmszCards = NULL;
LPTSTR pCard;
LONG lReturn;
DWORD cch = SCARD_AUTOALLOCATE;

// Retrieve the list of cards.
lReturn = SCardListCards(NULL,
                         NULL,
                         NULL,
                         NULL,
                         (LPTSTR)&pmszCards,
                         &cch );
if ( SCARD_S_SUCCESS != lReturn )
{
    printf("Failed SCardListCards\n");
    exit(1); // Or other appropriate error action
}
// Do something with the multi string of cards.
// Output the values.
// A double-null terminates the list of values.
pCard = pmszCards;
while ( '\0' != *pCard )
{
    // Display the value.
    printf("%S\n", pCard );
    // Advance to the next value.
    pCard = pCard + wcslen(pCard) + 1;
}

// Remember to free pmszCards (by calling SCardFreeMemory).
// ...

メモ

winscard.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SCardListCards を定義します。エンコーディング非依存のエイリアスの使用と、エンコーディング非依存ではないコードを混在させると、コンパイルエラーや実行時エラーを引き起こす不整合につながる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SCardListCardsW(
    UINT_PTR hContext,
    BYTE* pbAtr,   // optional
    const GUID* rgquidInterfaces,   // optional
    DWORD cguidInterfaceCount,
    LPWSTR mszCards,   // optional
    DWORD* pcchCards
);

[DllImport("WinSCard.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int SCardListCardsW(
    UIntPtr hContext,   // UINT_PTR
    IntPtr pbAtr,   // BYTE* optional
    IntPtr rgquidInterfaces,   // GUID* optional
    uint cguidInterfaceCount,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder mszCards,   // LPWSTR optional, out
    ref uint pcchCards   // DWORD* in/out
);

<DllImport("WinSCard.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SCardListCardsW(
    hContext As UIntPtr,   ' UINT_PTR
    pbAtr As IntPtr,   ' BYTE* optional
    rgquidInterfaces As IntPtr,   ' GUID* optional
    cguidInterfaceCount As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> mszCards As System.Text.StringBuilder,   ' LPWSTR optional, out
    ByRef pcchCards As UInteger   ' DWORD* in/out
) As Integer
End Function

' hContext : UINT_PTR
' pbAtr : BYTE* optional
' rgquidInterfaces : GUID* optional
' cguidInterfaceCount : DWORD
' mszCards : LPWSTR optional, out
' pcchCards : DWORD* in/out
Declare PtrSafe Function SCardListCardsW Lib "winscard" ( _
    ByVal hContext As LongPtr, _
    ByVal pbAtr As LongPtr, _
    ByVal rgquidInterfaces As LongPtr, _
    ByVal cguidInterfaceCount As Long, _
    ByVal mszCards As LongPtr, _
    ByRef pcchCards 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

SCardListCardsW = ctypes.windll.winscard.SCardListCardsW
SCardListCardsW.restype = ctypes.c_int
SCardListCardsW.argtypes = [
    ctypes.c_size_t,  # hContext : UINT_PTR
    ctypes.POINTER(ctypes.c_ubyte),  # pbAtr : BYTE* optional
    ctypes.c_void_p,  # rgquidInterfaces : GUID* optional
    wintypes.DWORD,  # cguidInterfaceCount : DWORD
    wintypes.LPWSTR,  # mszCards : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchCards : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WinSCard.dll')
SCardListCardsW = Fiddle::Function.new(
  lib['SCardListCardsW'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hContext : UINT_PTR
    Fiddle::TYPE_VOIDP,  # pbAtr : BYTE* optional
    Fiddle::TYPE_VOIDP,  # rgquidInterfaces : GUID* optional
    -Fiddle::TYPE_INT,  # cguidInterfaceCount : DWORD
    Fiddle::TYPE_VOIDP,  # mszCards : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchCards : DWORD* in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "winscard")]
extern "system" {
    fn SCardListCardsW(
        hContext: usize,  // UINT_PTR
        pbAtr: *mut u8,  // BYTE* optional
        rgquidInterfaces: *const GUID,  // GUID* optional
        cguidInterfaceCount: u32,  // DWORD
        mszCards: *mut u16,  // LPWSTR optional, out
        pcchCards: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WinSCard.dll", CharSet = CharSet.Unicode)]
public static extern int SCardListCardsW(UIntPtr hContext, IntPtr pbAtr, IntPtr rgquidInterfaces, uint cguidInterfaceCount, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder mszCards, ref uint pcchCards);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WinSCard_SCardListCardsW' -Namespace Win32 -PassThru
# $api::SCardListCardsW(hContext, pbAtr, rgquidInterfaces, cguidInterfaceCount, mszCards, pcchCards)

#uselib "WinSCard.dll"
#func global SCardListCardsW "SCardListCardsW" wptr, wptr, wptr, wptr, wptr, wptr
; SCardListCardsW hContext, varptr(pbAtr), varptr(rgquidInterfaces), cguidInterfaceCount, varptr(mszCards), varptr(pcchCards)   ; 戻り値は stat
; hContext : UINT_PTR -> "wptr"
; pbAtr : BYTE* optional -> "wptr"
; rgquidInterfaces : GUID* optional -> "wptr"
; cguidInterfaceCount : DWORD -> "wptr"
; mszCards : LPWSTR optional, out -> "wptr"
; pcchCards : DWORD* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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