ホーム › Security.Credentials › SCardGetReaderIconA

SCardGetReaderIconA

関数

指定したスマートカードリーダーのアイコン画像データを取得する(ANSI版)。

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

シグネチャ

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

INT SCardGetReaderIconA(
    UINT_PTR hContext,
    LPCSTR szReaderName,
    BYTE* pbIcon,
    DWORD* pcbIcon
);

パラメーター

名前	型	方向	説明
hContext	UINT_PTR	in	このクエリのリソースマネージャーコンテキストを識別するハンドル。リソースマネージャーコンテキストは、事前に SCardEstablishContext 関数を呼び出して設定できます。このパラメーターに NULL を指定することはできません。
szReaderName	LPCSTR	in	リーダー名。この値は SCardListReaders 関数を呼び出して取得できます。
pbIcon	BYTE*	out	アイコンファイルから読み取ったスマートカードリーダーアイコンの BLOB を格納するバッファーへのポインター。この値が NULL の場合、関数は pcbIcon パラメーターで指定されたバッファー長を無視し、このパラメーターが NULL でなければ返されていたであろうバッファー長を pcbIcon に書き込んで、成功コードを返します。
pcbIcon	DWORD*	inout	pbIcon バッファーの長さ(文字数)。このパラメーターは、受信した属性の実際の長さを受け取ります。バッファー長として SCARD_AUTOALLOCATE が指定された場合、pbIcon はポインターへのポインターからバイトポインターへのポインターに変換され、属性を格納するメモリブロックのアドレスを受け取ります。このメモリブロックは SCardFreeMemory 関数で解放する必要があります。

戻り値の型: INT

公式ドキュメント

指定したリーダー名に対応するスマートカードリーダーのアイコンを取得します。(ANSI)

戻り値

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

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

解説(Remarks)

アイコンは、アルファチャンネルを持たない 256 × 256 ピクセルである必要があります。

例

PBYTE    pbIcon = NULL;
DWORD    cbIcon = SCARD_AUTOALLOCATE;
DWORD    i;
LONG     lReturn;
LPTSTR   szReaderName = "USB Smart Card Reader 0";

// Retrieve the reader's icon.
// hContext was set by a previous call to SCardEstablishContext.
lReturn = SCardGetReaderIcon(hContext,
                         szReaderName,
                         (PBYTE)&pbIcon,
                         &cbIcon);

if ( SCARD_S_SUCCESS != lReturn )
{
    printf("Failed SCardGetReaderIcon - %x\n", lReturn);
    // Take appropriate action.
}
else
{
    // Free the memory when done. 
    lReturn = SCardFreeMemory(hContext, pbIcon);
}

メモ

winscard.h ヘッダーは SCardGetReaderIcon を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング非依存のエイリアスの使用と、エンコーディング非依存でないコードとを混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SCardGetReaderIconA(
    UINT_PTR hContext,
    LPCSTR szReaderName,
    BYTE* pbIcon,
    DWORD* pcbIcon
);

[DllImport("WinSCard.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int SCardGetReaderIconA(
    UIntPtr hContext,   // UINT_PTR
    [MarshalAs(UnmanagedType.LPStr)] string szReaderName,   // LPCSTR
    IntPtr pbIcon,   // BYTE* out
    ref uint pcbIcon   // DWORD* in/out
);

<DllImport("WinSCard.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SCardGetReaderIconA(
    hContext As UIntPtr,   ' UINT_PTR
    <MarshalAs(UnmanagedType.LPStr)> szReaderName As String,   ' LPCSTR
    pbIcon As IntPtr,   ' BYTE* out
    ByRef pcbIcon As UInteger   ' DWORD* in/out
) As Integer
End Function

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

import ctypes
from ctypes import wintypes

SCardGetReaderIconA = ctypes.windll.winscard.SCardGetReaderIconA
SCardGetReaderIconA.restype = ctypes.c_int
SCardGetReaderIconA.argtypes = [
    ctypes.c_size_t,  # hContext : UINT_PTR
    wintypes.LPCSTR,  # szReaderName : LPCSTR
    ctypes.POINTER(ctypes.c_ubyte),  # pbIcon : BYTE* out
    ctypes.POINTER(wintypes.DWORD),  # pcbIcon : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WinSCard.dll')
SCardGetReaderIconA = Fiddle::Function.new(
  lib['SCardGetReaderIconA'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hContext : UINT_PTR
    Fiddle::TYPE_VOIDP,  # szReaderName : LPCSTR
    Fiddle::TYPE_VOIDP,  # pbIcon : BYTE* out
    Fiddle::TYPE_VOIDP,  # pcbIcon : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "winscard")]
extern "system" {
    fn SCardGetReaderIconA(
        hContext: usize,  // UINT_PTR
        szReaderName: *const u8,  // LPCSTR
        pbIcon: *mut u8,  // BYTE* out
        pcbIcon: *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 SCardGetReaderIconA(UIntPtr hContext, [MarshalAs(UnmanagedType.LPStr)] string szReaderName, IntPtr pbIcon, ref uint pcbIcon);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WinSCard_SCardGetReaderIconA' -Namespace Win32 -PassThru
# $api::SCardGetReaderIconA(hContext, szReaderName, pbIcon, pcbIcon)

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

出力引数:

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