ホーム › Security.Credentials › SCardListReadersW

SCardListReadersW

関数

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

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

シグネチャ

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

INT SCardListReadersW(
    UINT_PTR hContext,
    LPCWSTR mszGroups,   // optional
    LPWSTR mszReaders,   // optional
    DWORD* pcchReaders
);

パラメーター

名前

型

方向

説明

hContext

UINT_PTR

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

このパラメーターを NULL に設定すると、リーダーの検索は特定のコンテキストに限定されません。

mszGroups

LPCWSTR

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

LPWSTR

outoptional

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

pcchReaders

DWORD*

inout

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

戻り値の型: INT

公式ドキュメント

名前付きリーダーグループのセット内のリーダーの一覧を、重複を排除して提供します。(Unicode)

戻り値

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

戻り値コード/値	説明
成功 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 ヘッダーは SCardListReaders を、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 SCardListReadersW(
    UINT_PTR hContext,
    LPCWSTR mszGroups,   // optional
    LPWSTR mszReaders,   // optional
    DWORD* pcchReaders
);

[DllImport("WinSCard.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int SCardListReadersW(
    UIntPtr hContext,   // UINT_PTR
    [MarshalAs(UnmanagedType.LPWStr)] string mszGroups,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder mszReaders,   // LPWSTR optional, out
    ref uint pcchReaders   // DWORD* in/out
);

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

' hContext : UINT_PTR
' mszGroups : LPCWSTR optional
' mszReaders : LPWSTR optional, out
' pcchReaders : DWORD* in/out
Declare PtrSafe Function SCardListReadersW Lib "winscard" ( _
    ByVal hContext As LongPtr, _
    ByVal mszGroups As LongPtr, _
    ByVal mszReaders As LongPtr, _
    ByRef pcchReaders 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

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WinSCard.dll')
SCardListReadersW = Fiddle::Function.new(
  lib['SCardListReadersW'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hContext : UINT_PTR
    Fiddle::TYPE_VOIDP,  # mszGroups : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # mszReaders : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchReaders : DWORD* in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "winscard")]
extern "system" {
    fn SCardListReadersW(
        hContext: usize,  // UINT_PTR
        mszGroups: *const u16,  // LPCWSTR optional
        mszReaders: *mut u16,  // LPWSTR 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.Unicode)]
public static extern int SCardListReadersW(UIntPtr hContext, [MarshalAs(UnmanagedType.LPWStr)] string mszGroups, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder mszReaders, ref uint pcchReaders);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WinSCard_SCardListReadersW' -Namespace Win32 -PassThru
# $api::SCardListReadersW(hContext, mszGroups, mszReaders, pcchReaders)

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

出力引数:

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