ホーム › Security.Credentials › SCardListReadersWithDeviceInstanceIdA

SCardListReadersWithDeviceInstanceIdA

関数

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

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

シグネチャ

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

INT SCardListReadersWithDeviceInstanceIdA(
    UINT_PTR hContext,
    LPCSTR szDeviceInstanceId,
    LPSTR mszReaders,   // optional
    DWORD* pcchReaders
);

パラメーター

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

戻り値の型: INT

公式ドキュメント

指定したデバイスインスタンス識別子を持つリーダーの一覧を取得します。この関数はリーダーの状態に影響を与えません。(ANSI)

戻り値

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

戻り値	説明
成功	SCARD_S_SUCCESS。
失敗	エラーコード。詳細については、 Smart Card Return Values を参照してください。

解説(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 を定義します。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こすことがあります。詳細については、Conventions for Function Prototypes を参照してください。

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

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

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

require 'fiddle'
require 'fiddle/import'

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

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

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

出力引数:

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