ホーム › Security.Credentials › SCardListCardsA

SCardListCardsA

関数

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

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

シグネチャ

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

INT SCardListCardsA(
    UINT_PTR hContext,
    BYTE* pbAtr,   // optional
    const GUID* rgquidInterfaces,   // optional
    DWORD cguidInterfaceCount,
    LPSTR 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	LPSTR	outoptional	見つかったスマートカードを列挙するマルチストリングです。この値がNULLの場合、SCardListCardsはpcchCardsで指定されたバッファー長を無視し、このパラメーターがNULLでなかった場合に返されるはずのバッファー長をpcchCardsに返したうえで、成功コードを返します。
pcchCards	DWORD*	inout	mszCardsバッファーの長さ(文字数)です。すべての末尾のnull文字を含む、マルチストリング構造体の実際の長さを受け取ります。バッファー長として SCARD_AUTOALLOCATE を指定した場合、mszCardsはバイトポインターへのポインターに変換され、マルチストリング構造体を含むメモリブロックのアドレスを受け取ります。このメモリブロックは SCardFreeMemoryで解放する必要があります。

戻り値の型: INT

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

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

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

SCardListCards関数はデータベースクエリ関数です。その他のデータベースクエリ関数の詳細については、スマートカードデータベースクエリ関数を参照してください。

この関数の呼び出しはトランザクションの外部で行う必要があります。アプリケーションが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 ヘッダーは、SCardListCards を、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 SCardListCardsA(
    UINT_PTR hContext,
    BYTE* pbAtr,   // optional
    const GUID* rgquidInterfaces,   // optional
    DWORD cguidInterfaceCount,
    LPSTR mszCards,   // optional
    DWORD* pcchCards
);

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

<DllImport("WinSCard.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SCardListCardsA(
    hContext As UIntPtr,   ' UINT_PTR
    pbAtr As IntPtr,   ' BYTE* optional
    rgquidInterfaces As IntPtr,   ' GUID* optional
    cguidInterfaceCount As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> mszCards As System.Text.StringBuilder,   ' LPSTR 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 : LPSTR optional, out
' pcchCards : DWORD* in/out
Declare PtrSafe Function SCardListCardsA Lib "winscard" ( _
    ByVal hContext As LongPtr, _
    ByVal pbAtr As LongPtr, _
    ByVal rgquidInterfaces As LongPtr, _
    ByVal cguidInterfaceCount As Long, _
    ByVal mszCards As String, _
    ByRef pcchCards As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SCardListCardsA = ctypes.windll.winscard.SCardListCardsA
SCardListCardsA.restype = ctypes.c_int
SCardListCardsA.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.LPSTR,  # mszCards : LPSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchCards : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WinSCard.dll')
SCardListCardsA = Fiddle::Function.new(
  lib['SCardListCardsA'],
  [
    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 : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchCards : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "winscard")]
extern "system" {
    fn SCardListCardsA(
        hContext: usize,  // UINT_PTR
        pbAtr: *mut u8,  // BYTE* optional
        rgquidInterfaces: *const GUID,  // GUID* optional
        cguidInterfaceCount: u32,  // DWORD
        mszCards: *mut u8,  // LPSTR 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.Ansi)]
public static extern int SCardListCardsA(UIntPtr hContext, IntPtr pbAtr, IntPtr rgquidInterfaces, uint cguidInterfaceCount, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder mszCards, ref uint pcchCards);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WinSCard_SCardListCardsA' -Namespace Win32 -PassThru
# $api::SCardListCardsA(hContext, pbAtr, rgquidInterfaces, cguidInterfaceCount, mszCards, pcchCards)

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

出力引数:

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