ホーム › Security.Credentials › SCardListReadersA

SCardListReadersA

関数

指定グループに属するスマートカードリーダーを列挙する。

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

シグネチャ

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

INT SCardListReadersA(
    UINT_PTR hContext,
    LPCSTR mszGroups,   // optional
    LPSTR mszReaders,   // optional
    DWORD* pcchReaders
);

パラメーター

名前

型

方向

説明

hContext

UINT_PTR

クエリの対象となるリソースマネージャーコンテキストを識別するハンドルです。リソースマネージャーコンテキストは、事前に SCardEstablishContext を呼び出して設定できます。

このパラメーターに NULL を指定した場合、リーダーの検索は特定のコンテキストに限定されません。

mszGroups

LPCSTR

inoptional

システムに定義されているリーダーグループの名前を、マルチ文字列として指定します。システム内のすべてのリーダー(すなわち SCard$AllReaders グループ)を列挙するには NULL 値を使用します。

値	意味
SCARD_ALL_READERS TEXT("SCard$AllReaders\000")	リーダーを列挙する際にグループ名を指定しなかった場合に使用されるグループです。リーダーがどのグループに属しているかにかかわらず、すべてのリーダーの一覧を返します。
SCARD_DEFAULT_READERS TEXT("SCard$DefaultReaders\000")	リーダーがシステムに導入されたときに、すべてのリーダーが追加される既定のグループです。
SCARD_LOCAL_READERS TEXT("SCard$LocalReaders\000")	使用されていないレガシー値です。これは内部で管理されるグループであり、リーダーグループ API を使用して変更することはできません。列挙のみを目的としています。
SCARD_SYSTEM_READERS TEXT("SCard$SystemReaders\000")	使用されていないレガシー値です。これは内部で管理されるグループであり、リーダーグループ API を使用して変更することはできません。列挙のみを目的としています。

mszReaders

LPSTR

outoptional

指定したリーダーグループ内のカードリーダーを列挙するマルチ文字列です。この値が NULL の場合、SCardListReaders は pcchReaders で指定されたバッファー長を無視し、このパラメーターが NULL でなかった場合に返されるはずのバッファー長を pcchReaders に書き込み、成功コードを返します。

pcchReaders

DWORD*

inout

mszReaders バッファーの長さ(文字数)です。このパラメーターは、すべての末尾の null 文字を含む、マルチ文字列構造の実際の長さを受け取ります。バッファー長として SCARD_AUTOALLOCATE を指定した場合、mszReaders はバイトポインターへのポインターに変換され、マルチ文字列構造を格納するメモリブロックのアドレスを受け取ります。このメモリブロックは SCardFreeMemory で解放する必要があります。

戻り値の型: INT

公式ドキュメント

指定された一連の名前付きリーダーグループ内のリーダーの一覧を、重複を除いて提供します。(ANSI)

戻り値

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

戻り値コード/値	説明
成功 0 (0x0)	SCARD_S_SUCCESS
グループにリーダーが含まれていない 2148532270 (0x8010002E)	SCARD_E_NO_READERS_AVAILABLE
指定されたリーダーが現在使用できない 2148532247 (0x80100017)	SCARD_E_READER_UNAVAILABLE
その他	エラーコードです。詳細については、スマートカードの戻り値を参照してください。

解説(Remarks)

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

例

次の例は、リーダーの一覧を取得する方法を示しています。

LPTSTR          pmszReaders = NULL;
LPTSTR          pReader;
LONG            lReturn, lReturn2;
DWORD           cch = SCARD_AUTOALLOCATE;

// Retrieve the list the readers.
// hSC was set by a previous call to SCardEstablishContext.
lReturn = SCardListReaders(hSC,
                           NULL,
                           (LPTSTR)&pmszReaders,
                           &cch );
switch( lReturn )
{
    case SCARD_E_NO_READERS_AVAILABLE:
        printf("Reader is not in groups.\n");
        // Take appropriate action.
        // ...
        break;

    case SCARD_S_SUCCESS:
        // Do something with the multi string of readers.
        // Output the values.
        // A double-null terminates the list of values.
        pReader = pmszReaders;
        while ( '\0' != *pReader )
        {
            // Display the value.
            printf("Reader: %S\n", pReader );
            // Advance to the next value.
            pReader = pReader + wcslen((wchar_t *)pReader) + 1;
        }
        // Free the memory.
        lReturn2 = SCardFreeMemory( hSC,
                                   pmszReaders );
        if ( SCARD_S_SUCCESS != lReturn2 )
            printf("Failed SCardFreeMemory\n");
        break;

default:
        printf("Failed SCardListReaders\n");
        // Take appropriate action.
        // ...
        break;
}

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SCardListReadersA(
    UINT_PTR hContext,
    LPCSTR mszGroups,   // optional
    LPSTR mszReaders,   // optional
    DWORD* pcchReaders
);

[DllImport("WinSCard.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int SCardListReadersA(
    UIntPtr hContext,   // UINT_PTR
    [MarshalAs(UnmanagedType.LPStr)] string mszGroups,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder mszReaders,   // LPSTR optional, out
    ref uint pcchReaders   // DWORD* in/out
);

<DllImport("WinSCard.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SCardListReadersA(
    hContext As UIntPtr,   ' UINT_PTR
    <MarshalAs(UnmanagedType.LPStr)> mszGroups As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> mszReaders As System.Text.StringBuilder,   ' LPSTR optional, out
    ByRef pcchReaders As UInteger   ' DWORD* in/out
) As Integer
End Function

' hContext : UINT_PTR
' mszGroups : LPCSTR optional
' mszReaders : LPSTR optional, out
' pcchReaders : DWORD* in/out
Declare PtrSafe Function SCardListReadersA Lib "winscard" ( _
    ByVal hContext As LongPtr, _
    ByVal mszGroups As String, _
    ByVal mszReaders As String, _
    ByRef pcchReaders As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SCardListReadersA = ctypes.windll.winscard.SCardListReadersA
SCardListReadersA.restype = ctypes.c_int
SCardListReadersA.argtypes = [
    ctypes.c_size_t,  # hContext : UINT_PTR
    wintypes.LPCSTR,  # mszGroups : LPCSTR optional
    wintypes.LPSTR,  # mszReaders : LPSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchReaders : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WinSCard.dll')
SCardListReadersA = Fiddle::Function.new(
  lib['SCardListReadersA'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hContext : UINT_PTR
    Fiddle::TYPE_VOIDP,  # mszGroups : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # mszReaders : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchReaders : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "winscard")]
extern "system" {
    fn SCardListReadersA(
        hContext: usize,  // UINT_PTR
        mszGroups: *const u8,  // LPCSTR optional
        mszReaders: *mut u8,  // LPSTR optional, out
        pcchReaders: *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 SCardListReadersA(UIntPtr hContext, [MarshalAs(UnmanagedType.LPStr)] string mszGroups, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder mszReaders, ref uint pcchReaders);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WinSCard_SCardListReadersA' -Namespace Win32 -PassThru
# $api::SCardListReadersA(hContext, mszGroups, mszReaders, pcchReaders)

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

出力引数:

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