ホーム › Security.Credentials › SCardWriteCacheA

SCardWriteCacheA

関数

スマートカードのキャッシュにデータを書き込む。

DLLWinSCard.dll文字セットANSI (-A)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

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

パラメーター

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

戻り値の型: INT

公式ドキュメント

スマートカードの名前と値のペアを、Smart Card Resource Manager が管理するグローバルキャッシュに書き込みます。(ANSI)

戻り値

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

関数が失敗した場合は、以下のいずれかのエラーコードを返します。詳細については、Smart Card Return Values を参照してください。

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

解説(Remarks)

メモ

winscard.h ヘッダーは SCardWriteCache をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーの原因となる場合があります。詳細については、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 SCardWriteCacheA(
    UINT_PTR hContext,
    GUID* CardIdentifier,
    DWORD FreshnessCounter,
    LPSTR LookupName,
    BYTE* Data,
    DWORD DataLen
);

[DllImport("WinSCard.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int SCardWriteCacheA(
    UIntPtr hContext,   // UINT_PTR
    ref Guid CardIdentifier,   // GUID*
    uint FreshnessCounter,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string LookupName,   // LPSTR
    IntPtr Data,   // BYTE*
    uint DataLen   // DWORD
);

<DllImport("WinSCard.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SCardWriteCacheA(
    hContext As UIntPtr,   ' UINT_PTR
    ByRef CardIdentifier As Guid,   ' GUID*
    FreshnessCounter As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> LookupName As String,   ' LPSTR
    Data As IntPtr,   ' BYTE*
    DataLen As UInteger   ' DWORD
) As Integer
End Function

' hContext : UINT_PTR
' CardIdentifier : GUID*
' FreshnessCounter : DWORD
' LookupName : LPSTR
' Data : BYTE*
' DataLen : DWORD
Declare PtrSafe Function SCardWriteCacheA Lib "winscard" ( _
    ByVal hContext As LongPtr, _
    ByVal CardIdentifier As LongPtr, _
    ByVal FreshnessCounter As Long, _
    ByVal LookupName As String, _
    ByVal Data As LongPtr, _
    ByVal DataLen As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SCardWriteCacheA = ctypes.windll.winscard.SCardWriteCacheA
SCardWriteCacheA.restype = ctypes.c_int
SCardWriteCacheA.argtypes = [
    ctypes.c_size_t,  # hContext : UINT_PTR
    ctypes.c_void_p,  # CardIdentifier : GUID*
    wintypes.DWORD,  # FreshnessCounter : DWORD
    wintypes.LPCSTR,  # LookupName : LPSTR
    ctypes.POINTER(ctypes.c_ubyte),  # Data : BYTE*
    wintypes.DWORD,  # DataLen : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WinSCard.dll')
SCardWriteCacheA = Fiddle::Function.new(
  lib['SCardWriteCacheA'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hContext : UINT_PTR
    Fiddle::TYPE_VOIDP,  # CardIdentifier : GUID*
    -Fiddle::TYPE_INT,  # FreshnessCounter : DWORD
    Fiddle::TYPE_VOIDP,  # LookupName : LPSTR
    Fiddle::TYPE_VOIDP,  # Data : BYTE*
    -Fiddle::TYPE_INT,  # DataLen : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "winscard")]
extern "system" {
    fn SCardWriteCacheA(
        hContext: usize,  // UINT_PTR
        CardIdentifier: *mut GUID,  // GUID*
        FreshnessCounter: u32,  // DWORD
        LookupName: *mut u8,  // LPSTR
        Data: *mut u8,  // BYTE*
        DataLen: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WinSCard.dll", CharSet = CharSet.Ansi)]
public static extern int SCardWriteCacheA(UIntPtr hContext, ref Guid CardIdentifier, uint FreshnessCounter, [MarshalAs(UnmanagedType.LPStr)] string LookupName, IntPtr Data, uint DataLen);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WinSCard_SCardWriteCacheA' -Namespace Win32 -PassThru
# $api::SCardWriteCacheA(hContext, CardIdentifier, FreshnessCounter, LookupName, Data, DataLen)

#uselib "WinSCard.dll"
#func global SCardWriteCacheA "SCardWriteCacheA" sptr, sptr, sptr, sptr, sptr, sptr
; SCardWriteCacheA hContext, varptr(CardIdentifier), FreshnessCounter, LookupName, varptr(Data), DataLen   ; 戻り値は stat
; hContext : UINT_PTR -> "sptr"
; CardIdentifier : GUID* -> "sptr"
; FreshnessCounter : DWORD -> "sptr"
; LookupName : LPSTR -> "sptr"
; Data : BYTE* -> "sptr"
; DataLen : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WinSCard.dll"
#cfunc global SCardWriteCacheA "SCardWriteCacheA" sptr, var, int, str, var, int
; res = SCardWriteCacheA(hContext, CardIdentifier, FreshnessCounter, LookupName, Data, DataLen)
; hContext : UINT_PTR -> "sptr"
; CardIdentifier : GUID* -> "var"
; FreshnessCounter : DWORD -> "int"
; LookupName : LPSTR -> "str"
; Data : BYTE* -> "var"
; DataLen : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WinSCard.dll"
#cfunc global SCardWriteCacheA "SCardWriteCacheA" sptr, sptr, int, str, sptr, int
; res = SCardWriteCacheA(hContext, varptr(CardIdentifier), FreshnessCounter, LookupName, varptr(Data), DataLen)
; hContext : UINT_PTR -> "sptr"
; CardIdentifier : GUID* -> "sptr"
; FreshnessCounter : DWORD -> "int"
; LookupName : LPSTR -> "str"
; Data : BYTE* -> "sptr"
; DataLen : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。