ホーム › Security.Credentials › SCardGetReaderIconW
SCardGetReaderIconW
関数指定したスマートカードリーダーのアイコン画像データを取得する(Unicode版)。
シグネチャ
// WinSCard.dll (Unicode / -W)
#include <windows.h>
INT SCardGetReaderIconW(
UINT_PTR hContext,
LPCWSTR szReaderName,
BYTE* pbIcon,
DWORD* pcbIcon
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hContext | UINT_PTR | in | クエリのリソースマネージャーコンテキストを識別するハンドルです。リソースマネージャーコンテキストは、事前に SCardEstablishContext 関数を呼び出して設定できます。このパラメーターを NULL にすることはできません。 |
| szReaderName | LPCWSTR | in | リーダー名です。この値は SCardListReaders 関数を呼び出して取得できます。 |
| pbIcon | BYTE* | out | アイコンファイルから読み取ったスマートカードリーダーのアイコンの BLOB を格納するバッファーへのポインターです。この値が NULL の場合、関数は pcbIcon パラメーターで指定されたバッファー長を無視し、このパラメーターが NULL でなかった場合に返されるであろうバッファーの長さを pcbIcon に書き込み、成功コードを返します。 |
| pcbIcon | DWORD* | inout | pbIcon バッファーの長さ(文字数)です。このパラメーターは、受信した属性の実際の長さを受け取ります。バッファー長として SCARD_AUTOALLOCATE が指定された場合、pbIcon はポインターからバイトポインターへ変換され、属性を格納するメモリブロックのアドレスを受け取ります。このメモリブロックは SCardFreeMemory 関数で解放する必要があります。 |
戻り値の型: INT
公式ドキュメント
指定したリーダー名に対応するスマートカードリーダーのアイコンを取得します。(Unicode)
戻り値
この関数は、成功するか失敗するかに応じて異なる値を返します。
| 戻り値 | 説明 |
|---|---|
|
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)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// WinSCard.dll (Unicode / -W)
#include <windows.h>
INT SCardGetReaderIconW(
UINT_PTR hContext,
LPCWSTR szReaderName,
BYTE* pbIcon,
DWORD* pcbIcon
);[DllImport("WinSCard.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int SCardGetReaderIconW(
UIntPtr hContext, // UINT_PTR
[MarshalAs(UnmanagedType.LPWStr)] string szReaderName, // LPCWSTR
IntPtr pbIcon, // BYTE* out
ref uint pcbIcon // DWORD* in/out
);<DllImport("WinSCard.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SCardGetReaderIconW(
hContext As UIntPtr, ' UINT_PTR
<MarshalAs(UnmanagedType.LPWStr)> szReaderName As String, ' LPCWSTR
pbIcon As IntPtr, ' BYTE* out
ByRef pcbIcon As UInteger ' DWORD* in/out
) As Integer
End Function' hContext : UINT_PTR
' szReaderName : LPCWSTR
' pbIcon : BYTE* out
' pcbIcon : DWORD* in/out
Declare PtrSafe Function SCardGetReaderIconW Lib "winscard" ( _
ByVal hContext As LongPtr, _
ByVal szReaderName As LongPtr, _
ByVal pbIcon As LongPtr, _
ByRef pcbIcon 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
SCardGetReaderIconW = ctypes.windll.winscard.SCardGetReaderIconW
SCardGetReaderIconW.restype = ctypes.c_int
SCardGetReaderIconW.argtypes = [
ctypes.c_size_t, # hContext : UINT_PTR
wintypes.LPCWSTR, # szReaderName : LPCWSTR
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')
SCardGetReaderIconW = Fiddle::Function.new(
lib['SCardGetReaderIconW'],
[
Fiddle::TYPE_UINTPTR_T, # hContext : UINT_PTR
Fiddle::TYPE_VOIDP, # szReaderName : LPCWSTR
Fiddle::TYPE_VOIDP, # pbIcon : BYTE* out
Fiddle::TYPE_VOIDP, # pcbIcon : DWORD* in/out
],
Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "winscard")]
extern "system" {
fn SCardGetReaderIconW(
hContext: usize, // UINT_PTR
szReaderName: *const u16, // LPCWSTR
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.Unicode)]
public static extern int SCardGetReaderIconW(UIntPtr hContext, [MarshalAs(UnmanagedType.LPWStr)] string szReaderName, IntPtr pbIcon, ref uint pcbIcon);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WinSCard_SCardGetReaderIconW' -Namespace Win32 -PassThru
# $api::SCardGetReaderIconW(hContext, szReaderName, pbIcon, pcbIcon)#uselib "WinSCard.dll"
#func global SCardGetReaderIconW "SCardGetReaderIconW" wptr, wptr, wptr, wptr
; SCardGetReaderIconW hContext, szReaderName, varptr(pbIcon), varptr(pcbIcon) ; 戻り値は stat
; hContext : UINT_PTR -> "wptr"
; szReaderName : LPCWSTR -> "wptr"
; pbIcon : BYTE* out -> "wptr"
; pcbIcon : DWORD* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "WinSCard.dll" #cfunc global SCardGetReaderIconW "SCardGetReaderIconW" sptr, wstr, var, var ; res = SCardGetReaderIconW(hContext, szReaderName, pbIcon, pcbIcon) ; hContext : UINT_PTR -> "sptr" ; szReaderName : LPCWSTR -> "wstr" ; pbIcon : BYTE* out -> "var" ; pcbIcon : DWORD* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WinSCard.dll" #cfunc global SCardGetReaderIconW "SCardGetReaderIconW" sptr, wstr, sptr, sptr ; res = SCardGetReaderIconW(hContext, szReaderName, varptr(pbIcon), varptr(pcbIcon)) ; hContext : UINT_PTR -> "sptr" ; szReaderName : LPCWSTR -> "wstr" ; pbIcon : BYTE* out -> "sptr" ; pcbIcon : DWORD* in/out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; INT SCardGetReaderIconW(UINT_PTR hContext, LPCWSTR szReaderName, BYTE* pbIcon, DWORD* pcbIcon) #uselib "WinSCard.dll" #cfunc global SCardGetReaderIconW "SCardGetReaderIconW" intptr, wstr, var, var ; res = SCardGetReaderIconW(hContext, szReaderName, pbIcon, pcbIcon) ; hContext : UINT_PTR -> "intptr" ; szReaderName : LPCWSTR -> "wstr" ; pbIcon : BYTE* out -> "var" ; pcbIcon : DWORD* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; INT SCardGetReaderIconW(UINT_PTR hContext, LPCWSTR szReaderName, BYTE* pbIcon, DWORD* pcbIcon) #uselib "WinSCard.dll" #cfunc global SCardGetReaderIconW "SCardGetReaderIconW" intptr, wstr, intptr, intptr ; res = SCardGetReaderIconW(hContext, szReaderName, varptr(pbIcon), varptr(pcbIcon)) ; hContext : UINT_PTR -> "intptr" ; szReaderName : LPCWSTR -> "wstr" ; pbIcon : BYTE* out -> "intptr" ; pcbIcon : DWORD* in/out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
winscard = windows.NewLazySystemDLL("WinSCard.dll")
procSCardGetReaderIconW = winscard.NewProc("SCardGetReaderIconW")
)
// hContext (UINT_PTR), szReaderName (LPCWSTR), pbIcon (BYTE* out), pcbIcon (DWORD* in/out)
r1, _, err := procSCardGetReaderIconW.Call(
uintptr(hContext),
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szReaderName))),
uintptr(pbIcon),
uintptr(pcbIcon),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction SCardGetReaderIconW(
hContext: NativeUInt; // UINT_PTR
szReaderName: PWideChar; // LPCWSTR
pbIcon: Pointer; // BYTE* out
pcbIcon: Pointer // DWORD* in/out
): Integer; stdcall;
external 'WinSCard.dll' name 'SCardGetReaderIconW';result := DllCall("WinSCard\SCardGetReaderIconW"
, "UPtr", hContext ; UINT_PTR
, "WStr", szReaderName ; LPCWSTR
, "Ptr", pbIcon ; BYTE* out
, "Ptr", pcbIcon ; DWORD* in/out
, "Int") ; return: INT●SCardGetReaderIconW(hContext, szReaderName, pbIcon, pcbIcon) = DLL("WinSCard.dll", "int SCardGetReaderIconW(int, char*, void*, void*)")
# 呼び出し: SCardGetReaderIconW(hContext, szReaderName, pbIcon, pcbIcon)
# hContext : UINT_PTR -> "int"
# szReaderName : LPCWSTR -> "char*"
# pbIcon : BYTE* out -> "void*"
# pcbIcon : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "winscard" fn SCardGetReaderIconW(
hContext: usize, // UINT_PTR
szReaderName: [*c]const u16, // LPCWSTR
pbIcon: [*c]u8, // BYTE* out
pcbIcon: [*c]u32 // DWORD* in/out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc SCardGetReaderIconW(
hContext: uint, # UINT_PTR
szReaderName: WideCString, # LPCWSTR
pbIcon: ptr uint8, # BYTE* out
pcbIcon: ptr uint32 # DWORD* in/out
): int32 {.importc: "SCardGetReaderIconW", stdcall, dynlib: "WinSCard.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "winscard");
extern(Windows)
int SCardGetReaderIconW(
size_t hContext, // UINT_PTR
const(wchar)* szReaderName, // LPCWSTR
ubyte* pbIcon, // BYTE* out
uint* pcbIcon // DWORD* in/out
);ccall((:SCardGetReaderIconW, "WinSCard.dll"), stdcall, Int32,
(Csize_t, Cwstring, Ptr{UInt8}, Ptr{UInt32}),
hContext, szReaderName, pbIcon, pcbIcon)
# hContext : UINT_PTR -> Csize_t
# szReaderName : LPCWSTR -> Cwstring
# pbIcon : BYTE* out -> Ptr{UInt8}
# pcbIcon : DWORD* in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
int32_t SCardGetReaderIconW(
uintptr_t hContext,
const uint16_t* szReaderName,
uint8_t* pbIcon,
uint32_t* pcbIcon);
]]
local winscard = ffi.load("winscard")
-- winscard.SCardGetReaderIconW(hContext, szReaderName, pbIcon, pcbIcon)
-- hContext : UINT_PTR
-- szReaderName : LPCWSTR
-- pbIcon : BYTE* out
-- pcbIcon : DWORD* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。const koffi = require('koffi');
const lib = koffi.load('WinSCard.dll');
const SCardGetReaderIconW = lib.func('__stdcall', 'SCardGetReaderIconW', 'int32_t', ['uintptr_t', 'str16', 'uint8_t *', 'uint32_t *']);
// SCardGetReaderIconW(hContext, szReaderName, pbIcon, pcbIcon)
// hContext : UINT_PTR -> 'uintptr_t'
// szReaderName : LPCWSTR -> 'str16'
// pbIcon : BYTE* out -> 'uint8_t *'
// pcbIcon : DWORD* in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("WinSCard.dll", {
SCardGetReaderIconW: { parameters: ["usize", "buffer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.SCardGetReaderIconW(hContext, szReaderName, pbIcon, pcbIcon)
// hContext : UINT_PTR -> "usize"
// szReaderName : LPCWSTR -> "buffer"
// pbIcon : BYTE* out -> "pointer"
// pcbIcon : DWORD* in/out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t SCardGetReaderIconW(
size_t hContext,
const uint16_t* szReaderName,
uint8_t* pbIcon,
uint32_t* pcbIcon);
C, "WinSCard.dll");
// $ffi->SCardGetReaderIconW(hContext, szReaderName, pbIcon, pcbIcon);
// hContext : UINT_PTR
// szReaderName : LPCWSTR
// pbIcon : BYTE* out
// pcbIcon : DWORD* in/out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Winscard extends StdCallLibrary {
Winscard INSTANCE = Native.load("winscard", Winscard.class, W32APIOptions.UNICODE_OPTIONS);
int SCardGetReaderIconW(
long hContext, // UINT_PTR
WString szReaderName, // LPCWSTR
byte[] pbIcon, // BYTE* out
IntByReference pcbIcon // DWORD* in/out
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("winscard")]
lib LibWinSCard
fun SCardGetReaderIconW = SCardGetReaderIconW(
hContext : LibC::SizeT, # UINT_PTR
szReaderName : UInt16*, # LPCWSTR
pbIcon : UInt8*, # BYTE* out
pcbIcon : UInt32* # DWORD* in/out
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef SCardGetReaderIconWNative = Int32 Function(UintPtr, Pointer<Utf16>, Pointer<Uint8>, Pointer<Uint32>);
typedef SCardGetReaderIconWDart = int Function(int, Pointer<Utf16>, Pointer<Uint8>, Pointer<Uint32>);
final SCardGetReaderIconW = DynamicLibrary.open('WinSCard.dll')
.lookupFunction<SCardGetReaderIconWNative, SCardGetReaderIconWDart>('SCardGetReaderIconW');
// hContext : UINT_PTR -> UintPtr
// szReaderName : LPCWSTR -> Pointer<Utf16>
// pbIcon : BYTE* out -> Pointer<Uint8>
// pcbIcon : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SCardGetReaderIconW(
hContext: NativeUInt; // UINT_PTR
szReaderName: PWideChar; // LPCWSTR
pbIcon: Pointer; // BYTE* out
pcbIcon: Pointer // DWORD* in/out
): Integer; stdcall;
external 'WinSCard.dll' name 'SCardGetReaderIconW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SCardGetReaderIconW"
c_SCardGetReaderIconW :: CUIntPtr -> CWString -> Ptr Word8 -> Ptr Word32 -> IO Int32
-- hContext : UINT_PTR -> CUIntPtr
-- szReaderName : LPCWSTR -> CWString
-- pbIcon : BYTE* out -> Ptr Word8
-- pcbIcon : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let scardgetreadericonw =
foreign "SCardGetReaderIconW"
(size_t @-> (ptr uint16_t) @-> (ptr uint8_t) @-> (ptr uint32_t) @-> returning int32_t)
(* hContext : UINT_PTR -> size_t *)
(* szReaderName : LPCWSTR -> (ptr uint16_t) *)
(* pbIcon : BYTE* out -> (ptr uint8_t) *)
(* pcbIcon : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library winscard (t "WinSCard.dll"))
(cffi:use-foreign-library winscard)
(cffi:defcfun ("SCardGetReaderIconW" scard-get-reader-icon-w :convention :stdcall) :int32
(h-context :uint64) ; UINT_PTR
(sz-reader-name (:string :encoding :utf-16le)) ; LPCWSTR
(pb-icon :pointer) ; BYTE* out
(pcb-icon :pointer)) ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SCardGetReaderIconW = Win32::API::More->new('WinSCard',
'int SCardGetReaderIconW(WPARAM hContext, LPCWSTR szReaderName, LPVOID pbIcon, LPVOID pcbIcon)');
# my $ret = $SCardGetReaderIconW->Call($hContext, $szReaderName, $pbIcon, $pcbIcon);
# hContext : UINT_PTR -> WPARAM
# szReaderName : LPCWSTR -> LPCWSTR
# pbIcon : BYTE* out -> LPVOID
# pcbIcon : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
文字セット違い
- f SCardGetReaderIconA (ANSI版) — 指定したスマートカードリーダーのアイコン画像データを取得する(ANSI版)。