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

SCardWriteCacheW

関数
スマートカードのコンテキストに対し、名前付きのデータをキャッシュへ書き込む。
DLLWinSCard.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

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

パラメーター

名前方向説明
hContextUINT_PTRinリソースマネージャーコンテキストを識別するハンドル。リソースマネージャーコンテキストは、事前の SCardEstablishContextの呼び出しによって設定されます。
CardIdentifierGUID*in名前と値のペアの読み取り元となったスマートカードを一意に識別する値へのポインター。
FreshnessCounterDWORDinキャッシュされたデータの現在のリビジョン。
LookupNameLPWSTRinグローバルキャッシュに書き込む名前と値のペアの名前部分を格納する、null で終わる文字列へのポインター。
DataBYTE*inグローバルキャッシュに書き込む名前と値のペアの値部分を格納するバイト値の配列へのポインター。
DataLenDWORDinData バッファーのサイズ(バイト単位)。

戻り値の型: INT

公式ドキュメント

スマートカードの名前と値のペアを、スマートカードリソースマネージャーが管理するグローバルキャッシュに書き込みます。(Unicode)

戻り値

関数が成功すると、SCARD_S_SUCCESS を返します。

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

戻り値コード/値 説明
SCARD_W_CACHE_ITEM_TOO_BIG
0x80100072
指定された名前と値のペアのサイズが、グローバルキャッシュに定義された最大サイズを超えています。

解説(Remarks)

メモ

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

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

SCardWriteCacheW = ctypes.windll.winscard.SCardWriteCacheW
SCardWriteCacheW.restype = ctypes.c_int
SCardWriteCacheW.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*
    wintypes.DWORD,  # DataLen : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	winscard = windows.NewLazySystemDLL("WinSCard.dll")
	procSCardWriteCacheW = winscard.NewProc("SCardWriteCacheW")
)

// hContext (UINT_PTR), CardIdentifier (GUID*), FreshnessCounter (DWORD), LookupName (LPWSTR), Data (BYTE*), DataLen (DWORD)
r1, _, err := procSCardWriteCacheW.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 SCardWriteCacheW(
  hContext: NativeUInt;   // UINT_PTR
  CardIdentifier: PGUID;   // GUID*
  FreshnessCounter: DWORD;   // DWORD
  LookupName: PWideChar;   // LPWSTR
  Data: Pointer;   // BYTE*
  DataLen: DWORD   // DWORD
): Integer; stdcall;
  external 'WinSCard.dll' name 'SCardWriteCacheW';
result := DllCall("WinSCard\SCardWriteCacheW"
    , "UPtr", hContext   ; UINT_PTR
    , "Ptr", CardIdentifier   ; GUID*
    , "UInt", FreshnessCounter   ; DWORD
    , "WStr", LookupName   ; LPWSTR
    , "Ptr", Data   ; BYTE*
    , "UInt", DataLen   ; DWORD
    , "Int")   ; return: INT
●SCardWriteCacheW(hContext, CardIdentifier, FreshnessCounter, LookupName, Data, DataLen) = DLL("WinSCard.dll", "int SCardWriteCacheW(int, void*, dword, char*, void*, dword)")
# 呼び出し: SCardWriteCacheW(hContext, CardIdentifier, FreshnessCounter, LookupName, Data, DataLen)
# hContext : UINT_PTR -> "int"
# CardIdentifier : GUID* -> "void*"
# FreshnessCounter : DWORD -> "dword"
# LookupName : LPWSTR -> "char*"
# Data : BYTE* -> "void*"
# DataLen : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

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

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

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

let scardwritecachew =
  foreign "SCardWriteCacheW"
    (size_t @-> (ptr void) @-> uint32_t @-> (ptr uint16_t) @-> (ptr uint8_t) @-> 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* -> (ptr uint8_t) *)
(* DataLen : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winscard (t "WinSCard.dll"))
(cffi:use-foreign-library winscard)

(cffi:defcfun ("SCardWriteCacheW" scard-write-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*
  (data-len :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SCardWriteCacheW = Win32::API::More->new('WinSCard',
    'int SCardWriteCacheW(WPARAM hContext, LPVOID CardIdentifier, DWORD FreshnessCounter, LPCWSTR LookupName, LPVOID Data, DWORD DataLen)');
# my $ret = $SCardWriteCacheW->Call($hContext, $CardIdentifier, $FreshnessCounter, $LookupName, $Data, $DataLen);
# hContext : UINT_PTR -> WPARAM
# CardIdentifier : GUID* -> LPVOID
# FreshnessCounter : DWORD -> DWORD
# LookupName : LPWSTR -> LPCWSTR
# Data : BYTE* -> LPVOID
# DataLen : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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