Win32 API 日本語リファレンス
ホームSecurity.Credentials › SCardReadCacheW

SCardReadCacheW

関数
スマートカードのキャッシュからデータを読み取る。
DLLWinSCard.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

INT SCardReadCacheW(
    UINT_PTR hContext,
    GUID* CardIdentifier,
    DWORD FreshnessCounter,
    LPWSTR LookupName,
    BYTE* Data,
    DWORD* DataLen
);

パラメーター

名前方向説明
hContextUINT_PTRinリソースマネージャーコンテキストを識別するハンドルです。リソースマネージャーコンテキストは、事前の SCardEstablishContext の呼び出しによって設定されます。
CardIdentifierGUID*inスマートカードを一意に識別する値へのポインターです。この関数がグローバルキャッシュから読み取る名前と値のペアは、このスマートカードに関連付けられています。
FreshnessCounterDWORDinキャッシュされたデータの現在のリビジョンです。
LookupNameLPWSTRin値部分を取得する対象となる名前と値のペアの、名前部分を含む null 終端文字列へのポインターです。
DataBYTE*outLookupName パラメーターで指定された名前と値のペアの値部分を含む、バイト値の配列へのポインターです。
DataLenDWORD*outData バッファーのサイズ(バイト単位)へのポインターです。

戻り値の型: INT

公式ドキュメント

スマートカードリソースマネージャーが管理するグローバルキャッシュから、名前と値のペアの値部分を取得します。(Unicode)

戻り値

関数が成功した場合は、SCARD_S_SUCCESS を返します。

関数が失敗した場合は、以下のエラーコードのいずれかを返します。詳細については、スマートカードの戻り値を参照してください。

戻り値/値 説明
SCARD_W_CACHE_ITEM_NOT_FOUND
0x80100070
指定された名前と値のペアがグローバルキャッシュ内で見つかりませんでした。
SCARD_W_CACHE_ITEM_STALE
0x80100071
指定された名前と値のペアは要求されたものより古く、キャッシュから削除されました。

解説(Remarks)

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SCardReadCacheW(
    UINT_PTR hContext,
    GUID* CardIdentifier,
    DWORD FreshnessCounter,
    LPWSTR LookupName,
    BYTE* Data,
    DWORD* DataLen
);
[DllImport("WinSCard.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int SCardReadCacheW(
    UIntPtr hContext,   // UINT_PTR
    ref Guid CardIdentifier,   // GUID*
    uint FreshnessCounter,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string LookupName,   // LPWSTR
    IntPtr Data,   // BYTE* out
    out uint DataLen   // DWORD* out
);
<DllImport("WinSCard.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SCardReadCacheW(
    hContext As UIntPtr,   ' UINT_PTR
    ByRef CardIdentifier As Guid,   ' GUID*
    FreshnessCounter As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> LookupName As String,   ' LPWSTR
    Data As IntPtr,   ' BYTE* out
    <Out> ByRef DataLen As UInteger   ' DWORD* out
) As Integer
End Function
' hContext : UINT_PTR
' CardIdentifier : GUID*
' FreshnessCounter : DWORD
' LookupName : LPWSTR
' Data : BYTE* out
' DataLen : DWORD* out
Declare PtrSafe Function SCardReadCacheW Lib "winscard" ( _
    ByVal hContext As LongPtr, _
    ByVal CardIdentifier As LongPtr, _
    ByVal FreshnessCounter As Long, _
    ByVal LookupName As LongPtr, _
    ByVal Data As LongPtr, _
    ByRef DataLen 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

SCardReadCacheW = ctypes.windll.winscard.SCardReadCacheW
SCardReadCacheW.restype = ctypes.c_int
SCardReadCacheW.argtypes = [
    ctypes.c_size_t,  # hContext : UINT_PTR
    ctypes.c_void_p,  # CardIdentifier : GUID*
    wintypes.DWORD,  # FreshnessCounter : DWORD
    wintypes.LPCWSTR,  # LookupName : LPWSTR
    ctypes.POINTER(ctypes.c_ubyte),  # Data : BYTE* out
    ctypes.POINTER(wintypes.DWORD),  # DataLen : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WinSCard.dll')
SCardReadCacheW = Fiddle::Function.new(
  lib['SCardReadCacheW'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hContext : UINT_PTR
    Fiddle::TYPE_VOIDP,  # CardIdentifier : GUID*
    -Fiddle::TYPE_INT,  # FreshnessCounter : DWORD
    Fiddle::TYPE_VOIDP,  # LookupName : LPWSTR
    Fiddle::TYPE_VOIDP,  # Data : BYTE* out
    Fiddle::TYPE_VOIDP,  # DataLen : DWORD* out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "winscard")]
extern "system" {
    fn SCardReadCacheW(
        hContext: usize,  // UINT_PTR
        CardIdentifier: *mut GUID,  // GUID*
        FreshnessCounter: u32,  // DWORD
        LookupName: *mut u16,  // LPWSTR
        Data: *mut u8,  // BYTE* out
        DataLen: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WinSCard.dll", CharSet = CharSet.Unicode)]
public static extern int SCardReadCacheW(UIntPtr hContext, ref Guid CardIdentifier, uint FreshnessCounter, [MarshalAs(UnmanagedType.LPWStr)] string LookupName, IntPtr Data, out uint DataLen);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WinSCard_SCardReadCacheW' -Namespace Win32 -PassThru
# $api::SCardReadCacheW(hContext, CardIdentifier, FreshnessCounter, LookupName, Data, DataLen)
#uselib "WinSCard.dll"
#func global SCardReadCacheW "SCardReadCacheW" wptr, wptr, wptr, wptr, wptr, wptr
; SCardReadCacheW hContext, varptr(CardIdentifier), FreshnessCounter, LookupName, varptr(Data), varptr(DataLen)   ; 戻り値は stat
; hContext : UINT_PTR -> "wptr"
; CardIdentifier : GUID* -> "wptr"
; FreshnessCounter : DWORD -> "wptr"
; LookupName : LPWSTR -> "wptr"
; Data : BYTE* out -> "wptr"
; DataLen : DWORD* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WinSCard.dll"
#cfunc global SCardReadCacheW "SCardReadCacheW" sptr, var, int, wstr, var, var
; res = SCardReadCacheW(hContext, CardIdentifier, FreshnessCounter, LookupName, Data, DataLen)
; hContext : UINT_PTR -> "sptr"
; CardIdentifier : GUID* -> "var"
; FreshnessCounter : DWORD -> "int"
; LookupName : LPWSTR -> "wstr"
; Data : BYTE* out -> "var"
; DataLen : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT SCardReadCacheW(UINT_PTR hContext, GUID* CardIdentifier, DWORD FreshnessCounter, LPWSTR LookupName, BYTE* Data, DWORD* DataLen)
#uselib "WinSCard.dll"
#cfunc global SCardReadCacheW "SCardReadCacheW" intptr, var, int, wstr, var, var
; res = SCardReadCacheW(hContext, CardIdentifier, FreshnessCounter, LookupName, Data, DataLen)
; hContext : UINT_PTR -> "intptr"
; CardIdentifier : GUID* -> "var"
; FreshnessCounter : DWORD -> "int"
; LookupName : LPWSTR -> "wstr"
; Data : BYTE* out -> "var"
; DataLen : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winscard = windows.NewLazySystemDLL("WinSCard.dll")
	procSCardReadCacheW = winscard.NewProc("SCardReadCacheW")
)

// hContext (UINT_PTR), CardIdentifier (GUID*), FreshnessCounter (DWORD), LookupName (LPWSTR), Data (BYTE* out), DataLen (DWORD* out)
r1, _, err := procSCardReadCacheW.Call(
	uintptr(hContext),
	uintptr(CardIdentifier),
	uintptr(FreshnessCounter),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(LookupName))),
	uintptr(Data),
	uintptr(DataLen),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function SCardReadCacheW(
  hContext: NativeUInt;   // UINT_PTR
  CardIdentifier: PGUID;   // GUID*
  FreshnessCounter: DWORD;   // DWORD
  LookupName: PWideChar;   // LPWSTR
  Data: Pointer;   // BYTE* out
  DataLen: Pointer   // DWORD* out
): Integer; stdcall;
  external 'WinSCard.dll' name 'SCardReadCacheW';
result := DllCall("WinSCard\SCardReadCacheW"
    , "UPtr", hContext   ; UINT_PTR
    , "Ptr", CardIdentifier   ; GUID*
    , "UInt", FreshnessCounter   ; DWORD
    , "WStr", LookupName   ; LPWSTR
    , "Ptr", Data   ; BYTE* out
    , "Ptr", DataLen   ; DWORD* out
    , "Int")   ; return: INT
●SCardReadCacheW(hContext, CardIdentifier, FreshnessCounter, LookupName, Data, DataLen) = DLL("WinSCard.dll", "int SCardReadCacheW(int, void*, dword, char*, void*, void*)")
# 呼び出し: SCardReadCacheW(hContext, CardIdentifier, FreshnessCounter, LookupName, Data, DataLen)
# hContext : UINT_PTR -> "int"
# CardIdentifier : GUID* -> "void*"
# FreshnessCounter : DWORD -> "dword"
# LookupName : LPWSTR -> "char*"
# Data : BYTE* out -> "void*"
# DataLen : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "winscard" fn SCardReadCacheW(
    hContext: usize, // UINT_PTR
    CardIdentifier: [*c]GUID, // GUID*
    FreshnessCounter: u32, // DWORD
    LookupName: [*c]const u16, // LPWSTR
    Data: [*c]u8, // BYTE* out
    DataLen: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SCardReadCacheW(
    hContext: uint,  # UINT_PTR
    CardIdentifier: ptr GUID,  # GUID*
    FreshnessCounter: uint32,  # DWORD
    LookupName: WideCString,  # LPWSTR
    Data: ptr uint8,  # BYTE* out
    DataLen: ptr uint32  # DWORD* out
): int32 {.importc: "SCardReadCacheW", stdcall, dynlib: "WinSCard.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "winscard");
extern(Windows)
int SCardReadCacheW(
    size_t hContext,   // UINT_PTR
    GUID* CardIdentifier,   // GUID*
    uint FreshnessCounter,   // DWORD
    const(wchar)* LookupName,   // LPWSTR
    ubyte* Data,   // BYTE* out
    uint* DataLen   // DWORD* out
);
ccall((:SCardReadCacheW, "WinSCard.dll"), stdcall, Int32,
      (Csize_t, Ptr{GUID}, UInt32, Cwstring, Ptr{UInt8}, Ptr{UInt32}),
      hContext, CardIdentifier, FreshnessCounter, LookupName, Data, DataLen)
# hContext : UINT_PTR -> Csize_t
# CardIdentifier : GUID* -> Ptr{GUID}
# FreshnessCounter : DWORD -> UInt32
# LookupName : LPWSTR -> Cwstring
# Data : BYTE* out -> Ptr{UInt8}
# DataLen : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SCardReadCacheW(
    uintptr_t hContext,
    void* CardIdentifier,
    uint32_t FreshnessCounter,
    const uint16_t* LookupName,
    uint8_t* Data,
    uint32_t* DataLen);
]]
local winscard = ffi.load("winscard")
-- winscard.SCardReadCacheW(hContext, CardIdentifier, FreshnessCounter, LookupName, Data, DataLen)
-- hContext : UINT_PTR
-- CardIdentifier : GUID*
-- FreshnessCounter : DWORD
-- LookupName : LPWSTR
-- Data : BYTE* out
-- DataLen : DWORD* 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 SCardReadCacheW = lib.func('__stdcall', 'SCardReadCacheW', 'int32_t', ['uintptr_t', 'void *', 'uint32_t', 'str16', 'uint8_t *', 'uint32_t *']);
// SCardReadCacheW(hContext, CardIdentifier, FreshnessCounter, LookupName, Data, DataLen)
// hContext : UINT_PTR -> 'uintptr_t'
// CardIdentifier : GUID* -> 'void *'
// FreshnessCounter : DWORD -> 'uint32_t'
// LookupName : LPWSTR -> 'str16'
// Data : BYTE* out -> 'uint8_t *'
// DataLen : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WinSCard.dll", {
  SCardReadCacheW: { parameters: ["usize", "pointer", "u32", "buffer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.SCardReadCacheW(hContext, CardIdentifier, FreshnessCounter, LookupName, Data, DataLen)
// hContext : UINT_PTR -> "usize"
// CardIdentifier : GUID* -> "pointer"
// FreshnessCounter : DWORD -> "u32"
// LookupName : LPWSTR -> "buffer"
// Data : BYTE* out -> "pointer"
// DataLen : DWORD* out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SCardReadCacheW(
    size_t hContext,
    void* CardIdentifier,
    uint32_t FreshnessCounter,
    const uint16_t* LookupName,
    uint8_t* Data,
    uint32_t* DataLen);
C, "WinSCard.dll");
// $ffi->SCardReadCacheW(hContext, CardIdentifier, FreshnessCounter, LookupName, Data, DataLen);
// hContext : UINT_PTR
// CardIdentifier : GUID*
// FreshnessCounter : DWORD
// LookupName : LPWSTR
// Data : BYTE* out
// DataLen : DWORD* 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 SCardReadCacheW(
        long hContext,   // UINT_PTR
        Pointer CardIdentifier,   // GUID*
        int FreshnessCounter,   // DWORD
        WString LookupName,   // LPWSTR
        byte[] Data,   // BYTE* out
        IntByReference DataLen   // DWORD* out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("winscard")]
lib LibWinSCard
  fun SCardReadCacheW = SCardReadCacheW(
    hContext : LibC::SizeT,   # UINT_PTR
    CardIdentifier : GUID*,   # GUID*
    FreshnessCounter : UInt32,   # DWORD
    LookupName : UInt16*,   # LPWSTR
    Data : UInt8*,   # BYTE* out
    DataLen : UInt32*   # DWORD* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SCardReadCacheWNative = Int32 Function(UintPtr, Pointer<Void>, Uint32, Pointer<Utf16>, Pointer<Uint8>, Pointer<Uint32>);
typedef SCardReadCacheWDart = int Function(int, Pointer<Void>, int, Pointer<Utf16>, Pointer<Uint8>, Pointer<Uint32>);
final SCardReadCacheW = DynamicLibrary.open('WinSCard.dll')
    .lookupFunction<SCardReadCacheWNative, SCardReadCacheWDart>('SCardReadCacheW');
// hContext : UINT_PTR -> UintPtr
// CardIdentifier : GUID* -> Pointer<Void>
// FreshnessCounter : DWORD -> Uint32
// LookupName : LPWSTR -> Pointer<Utf16>
// Data : BYTE* out -> Pointer<Uint8>
// DataLen : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SCardReadCacheW(
  hContext: NativeUInt;   // UINT_PTR
  CardIdentifier: PGUID;   // GUID*
  FreshnessCounter: DWORD;   // DWORD
  LookupName: PWideChar;   // LPWSTR
  Data: Pointer;   // BYTE* out
  DataLen: Pointer   // DWORD* out
): Integer; stdcall;
  external 'WinSCard.dll' name 'SCardReadCacheW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SCardReadCacheW"
  c_SCardReadCacheW :: CUIntPtr -> Ptr () -> Word32 -> CWString -> Ptr Word8 -> Ptr Word32 -> IO Int32
-- hContext : UINT_PTR -> CUIntPtr
-- CardIdentifier : GUID* -> Ptr ()
-- FreshnessCounter : DWORD -> Word32
-- LookupName : LPWSTR -> CWString
-- Data : BYTE* out -> Ptr Word8
-- DataLen : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let scardreadcachew =
  foreign "SCardReadCacheW"
    (size_t @-> (ptr void) @-> uint32_t @-> (ptr uint16_t) @-> (ptr uint8_t) @-> (ptr uint32_t) @-> returning int32_t)
(* hContext : UINT_PTR -> size_t *)
(* CardIdentifier : GUID* -> (ptr void) *)
(* FreshnessCounter : DWORD -> uint32_t *)
(* LookupName : LPWSTR -> (ptr uint16_t) *)
(* Data : BYTE* out -> (ptr uint8_t) *)
(* DataLen : DWORD* 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 ("SCardReadCacheW" scard-read-cache-w :convention :stdcall) :int32
  (h-context :uint64)   ; UINT_PTR
  (card-identifier :pointer)   ; GUID*
  (freshness-counter :uint32)   ; DWORD
  (lookup-name (:string :encoding :utf-16le))   ; LPWSTR
  (data :pointer)   ; BYTE* out
  (data-len :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SCardReadCacheW = Win32::API::More->new('WinSCard',
    'int SCardReadCacheW(WPARAM hContext, LPVOID CardIdentifier, DWORD FreshnessCounter, LPCWSTR LookupName, LPVOID Data, LPVOID DataLen)');
# my $ret = $SCardReadCacheW->Call($hContext, $CardIdentifier, $FreshnessCounter, $LookupName, $Data, $DataLen);
# hContext : UINT_PTR -> WPARAM
# CardIdentifier : GUID* -> LPVOID
# FreshnessCounter : DWORD -> DWORD
# LookupName : LPWSTR -> LPCWSTR
# Data : BYTE* out -> LPVOID
# DataLen : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目