ホーム › Security.Credentials › SCardListReadersWithDeviceInstanceIdW

SCardListReadersWithDeviceInstanceIdW

関数

指定デバイスインスタンスIDに対応するスマートカードリーダーを列挙する(Unicode版)。

DLLWinSCard.dll文字セットUnicode (-W)呼出規約winapi対応OSwindows8.0

シグネチャ

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

INT SCardListReadersWithDeviceInstanceIdW(
    UINT_PTR hContext,
    LPCWSTR szDeviceInstanceId,
    LPWSTR mszReaders,   // optional
    DWORD* pcchReaders
);

パラメーター

名前	型	方向	説明
hContext	UINT_PTR	in	クエリのリソースマネージャーコンテキストを識別するハンドル。リソースマネージャーコンテキストは、事前に SCardEstablishContext 関数を呼び出すことで設定できます。このパラメーターに NULL を指定することはできません。
szDeviceInstanceId	LPCWSTR	in	リーダーのデバイスインスタンス ID。この値は、リーダー名を指定して SCardGetReaderDeviceInstanceId 関数を呼び出すか、DDK の SetupDiGetDeviceInstanceId 関数を呼び出すことで取得できます。
mszReaders	LPWSTR	outoptional	指定したデバイスインスタンス識別子に含まれるスマートカードリーダーを格納するマルチ文字列。この値が NULL の場合、関数は pcchReaders パラメーターで指定されたバッファー長を無視し、このパラメーターが NULL でなかった場合に返されるはずのバッファー長を pcchReaders に書き込んで、成功コードを返します。
pcchReaders	DWORD*	inout	mszReaders バッファーの長さ(文字数)。このパラメーターは、すべての終端 null 文字を含むマルチ文字列構造の実際の長さを受け取ります。バッファー長に SCARD_AUTOALLOCATE を指定した場合、mszReaders はバイトポインターへのポインターに変換され、マルチ文字列構造を格納するメモリブロックのアドレスを受け取ります。このメモリの使用を終えたら、SCardFreeMemory 関数を使用して解放してください。

戻り値の型: INT

公式ドキュメント

デバイスインスタンス識別子を指定して、対応するリーダーの一覧を取得します。この関数はリーダーの状態に影響を与えません。(Unicode)

戻り値

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

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

解説(Remarks)

この関数はリダイレクトされません。リモートデスクトップセッション内で SCardListReadersWithDeviceInstanceId 関数を呼び出すと、SCARD_E_READER_UNAVAILABLE エラーコードで失敗します。

例


szDeviceInstanceIdcchReaderNameLONG     lReturn, lReturn2;

LPTSTR   pmszReaders = NULL;
LPTSTR   pReader = NULL;WCHAR
DWORD    cchReaderName = SCARD_AUTOALLOCATE;

// Retrieve the reader’s name from it’s device instance ID
// hContext was set by a previous call to SCardEstablishContext. 

// szDeviceInstanceId was obtained by calling SetupDiGetDeviceInstanceId
lReturn = SCardListReadersWithDeviceInstanceId (hContext,
                         szDeviceInstanceId,
                         (LPTSTR)&pmszReaders,
                         &cchReaderName);

switch( lReturn )
{
    case SCARD_E_NO_READERS_AVAILABLE:
        printf("No readers have the provided device instance ID.\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( hContext,
                                   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 版を自動的に選択するエイリアスとして SCardListReadersWithDeviceInstanceId を定義します。エンコーディング中立なエイリアスの使用を、エンコーディング中立でないコードと混在させると、不整合が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規則を参照してください。

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

[DllImport("WinSCard.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int SCardListReadersWithDeviceInstanceIdW(
    UIntPtr hContext,   // UINT_PTR
    [MarshalAs(UnmanagedType.LPWStr)] string szDeviceInstanceId,   // LPCWSTR
    [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 SCardListReadersWithDeviceInstanceIdW(
    hContext As UIntPtr,   ' UINT_PTR
    <MarshalAs(UnmanagedType.LPWStr)> szDeviceInstanceId As String,   ' LPCWSTR
    <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
' szDeviceInstanceId : LPCWSTR
' mszReaders : LPWSTR optional, out
' pcchReaders : DWORD* in/out
Declare PtrSafe Function SCardListReadersWithDeviceInstanceIdW Lib "winscard" ( _
    ByVal hContext As LongPtr, _
    ByVal szDeviceInstanceId 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

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WinSCard.dll')
SCardListReadersWithDeviceInstanceIdW = Fiddle::Function.new(
  lib['SCardListReadersWithDeviceInstanceIdW'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hContext : UINT_PTR
    Fiddle::TYPE_VOIDP,  # szDeviceInstanceId : LPCWSTR
    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 SCardListReadersWithDeviceInstanceIdW(
        hContext: usize,  // UINT_PTR
        szDeviceInstanceId: *const u16,  // LPCWSTR
        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 SCardListReadersWithDeviceInstanceIdW(UIntPtr hContext, [MarshalAs(UnmanagedType.LPWStr)] string szDeviceInstanceId, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder mszReaders, ref uint pcchReaders);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WinSCard_SCardListReadersWithDeviceInstanceIdW' -Namespace Win32 -PassThru
# $api::SCardListReadersWithDeviceInstanceIdW(hContext, szDeviceInstanceId, mszReaders, pcchReaders)

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

出力引数:

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