ホーム › Security.Credentials › SCardListReaderGroupsW

SCardListReaderGroupsW

関数

システムに定義されたリーダーグループを列挙する。

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

シグネチャ

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

INT SCardListReaderGroupsW(
    UINT_PTR hContext,
    LPWSTR mszGroups,   // optional
    DWORD* pcchGroups
);

パラメーター

名前

型

方向

説明

hContext

UINT_PTR

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

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

mszGroups

LPWSTR

outoptional

システムに定義され、現在のターミナル上で現在のユーザーが利用できるリーダーグループを列挙するマルチ文字列。この値が NULL の場合、SCardListReaderGroups は pcchGroups で指定されたバッファー長を無視し、このパラメーターが NULL でなかった場合に返されるはずのバッファー長を pcchGroups に書き込み、成功コードを返します。

値	意味
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 では変更できない、内部的に管理されるグループです。列挙のみを目的としています。

pcchGroups

DWORD*

inout

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

戻り値の型: INT

公式ドキュメント

以前にシステムへ登録されたリーダーグループの一覧を提供します。(Unicode)

戻り値

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

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

解説(Remarks)

グループは、少なくとも1つのリーダーを含む場合にのみ返されます。これにはグループ SCard$DefaultReaders が含まれます。グループ SCard$AllReaders は暗黙的にのみ存在するため、返されません。

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

例

次の例は、リーダーグループを列挙する方法を示しています。

LPTSTR          pmszReaderGroups = NULL;
LPTSTR          pReaderGroup;
LONG            lReturn;
DWORD           cch = SCARD_AUTOALLOCATE;
    
// Retrieve the list the reader groups.
// hSC was set by a previous call to SCardEstablishContext.
lReturn = SCardListReaderGroups(hSC,
                                (LPTSTR)&pmszReaderGroups,
                                &cch );
if ( SCARD_S_SUCCESS != lReturn )
    printf("Failed SCardListReaderGroups\n");
else
{
    // Do something with the multi string of reader groups.
    // Output the values.
    // A double-null terminates the list of values.
    pReaderGroup = pmszReaderGroups;
    while ( '\0' != *pReaderGroup )
    {
        // Display the value.
        printf("%S\n", pReaderGroup );
        // Advance to the next value.
        pReaderGroup = pReaderGroup + wcslen((wchar_t *) pReaderGroup) + 1;
    }

    // Remember to free pmszReaderGroups by a call to SCardFreeMemory.
    // ...
}

メモ

winscard.h ヘッダーは、SCardListReaderGroups を、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 SCardListReaderGroupsW(
    UINT_PTR hContext,
    LPWSTR mszGroups,   // optional
    DWORD* pcchGroups
);

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

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

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

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

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "winscard")]
extern "system" {
    fn SCardListReaderGroupsW(
        hContext: usize,  // UINT_PTR
        mszGroups: *mut u16,  // LPWSTR optional, out
        pcchGroups: *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 SCardListReaderGroupsW(UIntPtr hContext, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder mszGroups, ref uint pcchGroups);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WinSCard_SCardListReaderGroupsW' -Namespace Win32 -PassThru
# $api::SCardListReaderGroupsW(hContext, mszGroups, pcchGroups)

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

出力引数:

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