ホーム › Security.Credentials › SCardIntroduceCardTypeW

SCardIntroduceCardTypeW

関数

新しいスマートカード種別をシステムに登録する。

DLLWinSCard.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

INT SCardIntroduceCardTypeW(
    UINT_PTR hContext,
    LPCWSTR szCardName,
    const GUID* pguidPrimaryProvider,   // optional
    const GUID* rgguidInterfaces,   // optional
    DWORD dwInterfaceCount,
    BYTE* pbAtr,
    BYTE* pbAtrMask,
    DWORD cbAtrLen
);

パラメーター

名前	型	方向	説明
hContext	UINT_PTR	in	リソースマネージャーコンテキストを識別するハンドル。リソースマネージャーコンテキストは、事前の SCardEstablishContext 呼び出しによって設定されます。このパラメーターを NULL にすることはできません。
szCardName	LPCWSTR	in	ユーザーがカードを認識できる名前。
pguidPrimaryProvider	GUID*	inoptional	スマートカードのプライマリサービスプロバイダーの識別子 (GUID) へのポインター。
rgguidInterfaces	GUID*	inoptional	スマートカードがサポートするインターフェイスを識別する識別子 (GUID) の配列。
dwInterfaceCount	DWORD	in	rgguidInterfaces 配列内の識別子の数。
pbAtr	BYTE*	in	スマートカードデータベースを照会する際に照合目的で使用できるATR 文字列 (詳細については SCardListCards を参照)。この文字列の長さは、通常の ATR 解析によって決定されます。
pbAtrMask	BYTE*	in	スマートカードの ATR を pbAtr で指定した ATR と比較する際に使用する省略可能なビットマスク。この値が NULL 以外の場合は、pbAtr で指定した ATR 文字列と同じ長さのバイト列を指している必要があります。指定された ATR 文字列 A を pbAtr で指定した ATR と比較した場合、A & M = pbAtr のとき (かつそのときに限り) 一致します。ここで M は指定されたマスクであり、& はビット単位の AND を表します。
cbAtrLen	DWORD	in	ATR および省略可能な ATR マスクの長さ。この値がゼロの場合、ATR の長さは通常の ATR 解析によって決定されます。pbAtr の値が指定されている場合、この値をゼロにすることはできません。

戻り値の型: INT

公式ドキュメント

スマートカードをスマートカードデータベースに追加することで、(アクティブなユーザーに対して) スマートカードサブシステムに導入します。(Unicode)

戻り値

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

戻り値	説明
成功	SCARD_S_SUCCESS。
失敗	エラーコード。詳細については Smart Card Return Values を参照してください。

解説(Remarks)

この関数はリダイレクトされませんが、リモートデスクトップセッション内で呼び出してもエラーにはなりません。それは単に、結果がローカルコンピューターではなくリモートコンピューターから返されることを意味するだけです。

SCardIntroduceCardType 関数はデータベース管理関数です。その他のデータベース管理関数の詳細については、 Smart Card Database Management Functions を参照してください。

スマートカードを削除するには、 SCardForgetCardType を使用します。

例

次の例は、カードの種類を導入する方法を示しています。この例では、hContext が事前の SCardEstablishContext 関数の呼び出しから取得した有効なハンドルであることを前提としています。

GUID  MyGuid = { 0xABCDEF00,
                 0xABCD,
                 0xABCD,
                 0xAA, 0xBB, 0xCC, 0xDD,
                 0xAA, 0xBB, 0xCC, 0xDD };

static const BYTE MyATR[] =     { 0xaa, 0xbb, 0xcc, 0x00, 0xdd };
static const BYTE MyATRMask[] = { 0xff, 0xff, 0xff, 0x00, 0xff};

LONG            lReturn;

lReturn = SCardIntroduceCardType(hContext, 
                                 L"MyCardName",
                                 &MyGuid,
                                 NULL,    // No interface array
                                 0,       // Interface count = 0
                                 MyATR,
                                 MyATRMask,
                                 sizeof(MyATR));
if ( SCARD_S_SUCCESS != lReturn )
    printf("Failed SCardIntroduceCardType\n");

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SCardIntroduceCardTypeW(
    UINT_PTR hContext,
    LPCWSTR szCardName,
    const GUID* pguidPrimaryProvider,   // optional
    const GUID* rgguidInterfaces,   // optional
    DWORD dwInterfaceCount,
    BYTE* pbAtr,
    BYTE* pbAtrMask,
    DWORD cbAtrLen
);

[DllImport("WinSCard.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int SCardIntroduceCardTypeW(
    UIntPtr hContext,   // UINT_PTR
    [MarshalAs(UnmanagedType.LPWStr)] string szCardName,   // LPCWSTR
    IntPtr pguidPrimaryProvider,   // GUID* optional
    IntPtr rgguidInterfaces,   // GUID* optional
    uint dwInterfaceCount,   // DWORD
    IntPtr pbAtr,   // BYTE*
    IntPtr pbAtrMask,   // BYTE*
    uint cbAtrLen   // DWORD
);

<DllImport("WinSCard.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SCardIntroduceCardTypeW(
    hContext As UIntPtr,   ' UINT_PTR
    <MarshalAs(UnmanagedType.LPWStr)> szCardName As String,   ' LPCWSTR
    pguidPrimaryProvider As IntPtr,   ' GUID* optional
    rgguidInterfaces As IntPtr,   ' GUID* optional
    dwInterfaceCount As UInteger,   ' DWORD
    pbAtr As IntPtr,   ' BYTE*
    pbAtrMask As IntPtr,   ' BYTE*
    cbAtrLen As UInteger   ' DWORD
) As Integer
End Function

' hContext : UINT_PTR
' szCardName : LPCWSTR
' pguidPrimaryProvider : GUID* optional
' rgguidInterfaces : GUID* optional
' dwInterfaceCount : DWORD
' pbAtr : BYTE*
' pbAtrMask : BYTE*
' cbAtrLen : DWORD
Declare PtrSafe Function SCardIntroduceCardTypeW Lib "winscard" ( _
    ByVal hContext As LongPtr, _
    ByVal szCardName As LongPtr, _
    ByVal pguidPrimaryProvider As LongPtr, _
    ByVal rgguidInterfaces As LongPtr, _
    ByVal dwInterfaceCount As Long, _
    ByVal pbAtr As LongPtr, _
    ByVal pbAtrMask As LongPtr, _
    ByVal cbAtrLen 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

SCardIntroduceCardTypeW = ctypes.windll.winscard.SCardIntroduceCardTypeW
SCardIntroduceCardTypeW.restype = ctypes.c_int
SCardIntroduceCardTypeW.argtypes = [
    ctypes.c_size_t,  # hContext : UINT_PTR
    wintypes.LPCWSTR,  # szCardName : LPCWSTR
    ctypes.c_void_p,  # pguidPrimaryProvider : GUID* optional
    ctypes.c_void_p,  # rgguidInterfaces : GUID* optional
    wintypes.DWORD,  # dwInterfaceCount : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pbAtr : BYTE*
    ctypes.POINTER(ctypes.c_ubyte),  # pbAtrMask : BYTE*
    wintypes.DWORD,  # cbAtrLen : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WinSCard.dll')
SCardIntroduceCardTypeW = Fiddle::Function.new(
  lib['SCardIntroduceCardTypeW'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hContext : UINT_PTR
    Fiddle::TYPE_VOIDP,  # szCardName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pguidPrimaryProvider : GUID* optional
    Fiddle::TYPE_VOIDP,  # rgguidInterfaces : GUID* optional
    -Fiddle::TYPE_INT,  # dwInterfaceCount : DWORD
    Fiddle::TYPE_VOIDP,  # pbAtr : BYTE*
    Fiddle::TYPE_VOIDP,  # pbAtrMask : BYTE*
    -Fiddle::TYPE_INT,  # cbAtrLen : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "winscard")]
extern "system" {
    fn SCardIntroduceCardTypeW(
        hContext: usize,  // UINT_PTR
        szCardName: *const u16,  // LPCWSTR
        pguidPrimaryProvider: *const GUID,  // GUID* optional
        rgguidInterfaces: *const GUID,  // GUID* optional
        dwInterfaceCount: u32,  // DWORD
        pbAtr: *mut u8,  // BYTE*
        pbAtrMask: *mut u8,  // BYTE*
        cbAtrLen: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WinSCard.dll", CharSet = CharSet.Unicode)]
public static extern int SCardIntroduceCardTypeW(UIntPtr hContext, [MarshalAs(UnmanagedType.LPWStr)] string szCardName, IntPtr pguidPrimaryProvider, IntPtr rgguidInterfaces, uint dwInterfaceCount, IntPtr pbAtr, IntPtr pbAtrMask, uint cbAtrLen);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WinSCard_SCardIntroduceCardTypeW' -Namespace Win32 -PassThru
# $api::SCardIntroduceCardTypeW(hContext, szCardName, pguidPrimaryProvider, rgguidInterfaces, dwInterfaceCount, pbAtr, pbAtrMask, cbAtrLen)

#uselib "WinSCard.dll"
#func global SCardIntroduceCardTypeW "SCardIntroduceCardTypeW" wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr
; SCardIntroduceCardTypeW hContext, szCardName, varptr(pguidPrimaryProvider), varptr(rgguidInterfaces), dwInterfaceCount, varptr(pbAtr), varptr(pbAtrMask), cbAtrLen   ; 戻り値は stat
; hContext : UINT_PTR -> "wptr"
; szCardName : LPCWSTR -> "wptr"
; pguidPrimaryProvider : GUID* optional -> "wptr"
; rgguidInterfaces : GUID* optional -> "wptr"
; dwInterfaceCount : DWORD -> "wptr"
; pbAtr : BYTE* -> "wptr"
; pbAtrMask : BYTE* -> "wptr"
; cbAtrLen : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WinSCard.dll"
#cfunc global SCardIntroduceCardTypeW "SCardIntroduceCardTypeW" sptr, wstr, var, var, int, var, var, int
; res = SCardIntroduceCardTypeW(hContext, szCardName, pguidPrimaryProvider, rgguidInterfaces, dwInterfaceCount, pbAtr, pbAtrMask, cbAtrLen)
; hContext : UINT_PTR -> "sptr"
; szCardName : LPCWSTR -> "wstr"
; pguidPrimaryProvider : GUID* optional -> "var"
; rgguidInterfaces : GUID* optional -> "var"
; dwInterfaceCount : DWORD -> "int"
; pbAtr : BYTE* -> "var"
; pbAtrMask : BYTE* -> "var"
; cbAtrLen : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WinSCard.dll"
#cfunc global SCardIntroduceCardTypeW "SCardIntroduceCardTypeW" sptr, wstr, sptr, sptr, int, sptr, sptr, int
; res = SCardIntroduceCardTypeW(hContext, szCardName, varptr(pguidPrimaryProvider), varptr(rgguidInterfaces), dwInterfaceCount, varptr(pbAtr), varptr(pbAtrMask), cbAtrLen)
; hContext : UINT_PTR -> "sptr"
; szCardName : LPCWSTR -> "wstr"
; pguidPrimaryProvider : GUID* optional -> "sptr"
; rgguidInterfaces : GUID* optional -> "sptr"
; dwInterfaceCount : DWORD -> "int"
; pbAtr : BYTE* -> "sptr"
; pbAtrMask : BYTE* -> "sptr"
; cbAtrLen : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。