ホーム › Security.Credentials › SCardSetAttrib

SCardSetAttrib

関数

スマートカードリーダーの属性値を設定する。

DLLWinSCard.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

// WinSCard.dll
#include <windows.h>

INT SCardSetAttrib(
    UINT_PTR hCard,
    DWORD dwAttrId,
    BYTE* pbAttr,
    DWORD cbAttrLen
);

パラメーター

名前

型

方向

説明

hCard

UINT_PTR

SCardConnect から返された参照値。

dwAttrId

DWORD

設定する属性の識別子。これらの値は書き込み専用です。ベンダーによってはすべての属性をサポートしていない場合があることに注意してください。

値	意味
SCARD_ATTR_SUPRESS_T1_IFS_REQUEST	リーダーからカードへの T=1 IFSD パケットの送信を抑制します。(現在挿入されているカードが IFSD 要求をサポートしていない場合に使用できます。)

pbAttr

BYTE*

dwAttrId で指定した ID を持つ属性を提供するバッファーへのポインター。

cbAttrLen

DWORD

pbAttr バッファー内の属性値の長さ(バイト単位)。

戻り値の型: INT

公式ドキュメント

指定したハンドルに対して、指定したリーダー属性を設定します。

戻り値

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

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

解説(Remarks)

SCardSetAttrib 関数はカードへの直接アクセス関数です。その他の直接アクセス関数については、直接カードアクセス関数を参照してください。

例

次の例は、属性を設定する方法を示しています。

// 属性を設定します。
// hCardHandle は前回の SCardConnect の呼び出しで設定されています。
// dwAttrID は属性 ID を指定する DWORD 値です。
// pbAttr は新しい値のバッファーを指します。
// cByte はバッファー内のバイト数です。
lReturn = SCardSetAttrib(hCardHandle,
                         dwAttrID,
                         (LPBYTE)pbAttr,
                         cByte);
if ( SCARD_S_SUCCESS != lReturn )
    printf("Failed SCardSetAttrib\n");

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// WinSCard.dll
#include <windows.h>

INT SCardSetAttrib(
    UINT_PTR hCard,
    DWORD dwAttrId,
    BYTE* pbAttr,
    DWORD cbAttrLen
);

[DllImport("WinSCard.dll", ExactSpelling = true)]
static extern int SCardSetAttrib(
    UIntPtr hCard,   // UINT_PTR
    uint dwAttrId,   // DWORD
    IntPtr pbAttr,   // BYTE*
    uint cbAttrLen   // DWORD
);

<DllImport("WinSCard.dll", ExactSpelling:=True)>
Public Shared Function SCardSetAttrib(
    hCard As UIntPtr,   ' UINT_PTR
    dwAttrId As UInteger,   ' DWORD
    pbAttr As IntPtr,   ' BYTE*
    cbAttrLen As UInteger   ' DWORD
) As Integer
End Function

' hCard : UINT_PTR
' dwAttrId : DWORD
' pbAttr : BYTE*
' cbAttrLen : DWORD
Declare PtrSafe Function SCardSetAttrib Lib "winscard" ( _
    ByVal hCard As LongPtr, _
    ByVal dwAttrId As Long, _
    ByVal pbAttr As LongPtr, _
    ByVal cbAttrLen As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SCardSetAttrib = ctypes.windll.winscard.SCardSetAttrib
SCardSetAttrib.restype = ctypes.c_int
SCardSetAttrib.argtypes = [
    ctypes.c_size_t,  # hCard : UINT_PTR
    wintypes.DWORD,  # dwAttrId : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pbAttr : BYTE*
    wintypes.DWORD,  # cbAttrLen : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WinSCard.dll')
SCardSetAttrib = Fiddle::Function.new(
  lib['SCardSetAttrib'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hCard : UINT_PTR
    -Fiddle::TYPE_INT,  # dwAttrId : DWORD
    Fiddle::TYPE_VOIDP,  # pbAttr : BYTE*
    -Fiddle::TYPE_INT,  # cbAttrLen : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "winscard")]
extern "system" {
    fn SCardSetAttrib(
        hCard: usize,  // UINT_PTR
        dwAttrId: u32,  // DWORD
        pbAttr: *mut u8,  // BYTE*
        cbAttrLen: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WinSCard.dll")]
public static extern int SCardSetAttrib(UIntPtr hCard, uint dwAttrId, IntPtr pbAttr, uint cbAttrLen);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WinSCard_SCardSetAttrib' -Namespace Win32 -PassThru
# $api::SCardSetAttrib(hCard, dwAttrId, pbAttr, cbAttrLen)

#uselib "WinSCard.dll"
#func global SCardSetAttrib "SCardSetAttrib" sptr, sptr, sptr, sptr
; SCardSetAttrib hCard, dwAttrId, varptr(pbAttr), cbAttrLen   ; 戻り値は stat
; hCard : UINT_PTR -> "sptr"
; dwAttrId : DWORD -> "sptr"
; pbAttr : BYTE* -> "sptr"
; cbAttrLen : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WinSCard.dll"
#cfunc global SCardSetAttrib "SCardSetAttrib" sptr, int, var, int
; res = SCardSetAttrib(hCard, dwAttrId, pbAttr, cbAttrLen)
; hCard : UINT_PTR -> "sptr"
; dwAttrId : DWORD -> "int"
; pbAttr : BYTE* -> "var"
; cbAttrLen : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WinSCard.dll"
#cfunc global SCardSetAttrib "SCardSetAttrib" sptr, int, sptr, int
; res = SCardSetAttrib(hCard, dwAttrId, varptr(pbAttr), cbAttrLen)
; hCard : UINT_PTR -> "sptr"
; dwAttrId : DWORD -> "int"
; pbAttr : BYTE* -> "sptr"
; cbAttrLen : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。