ホーム › Security.Credentials › SCardGetReaderDeviceInstanceIdA

SCardGetReaderDeviceInstanceIdA

関数

スマートカードリーダーのデバイスインスタンスIDを取得する(ANSI版)。

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

シグネチャ

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

INT SCardGetReaderDeviceInstanceIdA(
    UINT_PTR hContext,
    LPCSTR szReaderName,
    LPSTR szDeviceInstanceId,   // optional
    DWORD* pcchDeviceInstanceId
);

パラメーター

名前	型	方向	説明
hContext	UINT_PTR	in	クエリのリソースマネージャーコンテキストを識別するハンドルです。リソースマネージャーコンテキストは、事前に SCardEstablishContext 関数を呼び出すことで設定できます。このパラメーターを NULL にすることはできません。
szReaderName	LPCSTR	in	リーダー名です。この値は SCardListReaders 関数を呼び出すことで取得できます。
szDeviceInstanceId	LPSTR	outoptional	リーダーのデバイスインスタンス ID を受け取るバッファーです。この値が NULL の場合、関数は cchDeviceInstanceId パラメーターで指定されたバッファー長を無視し、このパラメーターが NULL でなかった場合に返されたであろうバッファー長を cchDeviceInstanceId に書き込み、成功コードを返します。
pcchDeviceInstanceId	DWORD*	inout	szDeviceInstanceId バッファーの長さ（NULL 終端文字を含む、文字数単位）です。バッファー長として SCARD_AUTOALLOCATE を指定した場合、szDeviceInstanceId パラメーターはバイトポインターへのポインターに変換され、インスタンス ID を格納するメモリブロックのアドレスを受け取ります。このメモリブロックは SCardFreeMemory 関数で解放する必要があります。

戻り値の型: INT

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

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

使用例


LONG     lReturn;
LPTSTR   szReaderName = "USB Smart Card Reader 0";
WCHAR    szDeviceInstanceId[256];
DWORD    cchDeviceInstanceId = 256;

// リーダーのデバイスインスタンス ID を取得します。
// hContext は事前の SCardEstablishContext 呼び出しによって設定されています。
lReturn = SCardGetReaderDeviceInstanceId (hContext,
                         szReaderName,
                         szDeviceInstanceId,
                         &cchDeviceInstanceId);

if ( SCARD_S_SUCCESS != lReturn )
{
    printf("Failed SCardGetReaderDeviceInstanceId - %x\n", lReturn);
    // 適切な処理を行います。
}

メモ

winscard.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SCardGetReaderDeviceInstanceId を定義しています。エンコーディング中立なエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不整合につながる場合があります。詳細については、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 SCardGetReaderDeviceInstanceIdA(
    UINT_PTR hContext,
    LPCSTR szReaderName,
    LPSTR szDeviceInstanceId,   // optional
    DWORD* pcchDeviceInstanceId
);

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

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

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

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

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

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

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

出力引数:

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