ホーム › Security.Credentials › SCardGetCardTypeProviderNameW

SCardGetCardTypeProviderNameW

関数

指定カード種別のプロバイダー名を取得する。

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

シグネチャ

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

INT SCardGetCardTypeProviderNameW(
    UINT_PTR hContext,
    LPCWSTR szCardName,
    DWORD dwProviderId,
    LPWSTR szProvider,
    DWORD* pcchProvider
);

パラメーター

名前

型

方向

説明

hContext

UINT_PTR

リソースマネージャーコンテキストを識別するハンドルです。リソースマネージャーコンテキストは、事前の SCardEstablishContext の呼び出しで設定できます。SCardGetCardTypeProviderName の呼び出しが特定のコンテキストに向けられていない場合、この値は NULL にできます。

szCardName

LPCWSTR

このプロバイダー名が関連付けられているカード種別の名前です。

dwProviderId

DWORD

このカード種別に関連付けられたプロバイダーの識別子です。

値	意味
SCARD_PROVIDER_PRIMARY 1	この関数は、スマートカードのプライマリサービスプロバイダーの名前を GUID 文字列として取得します。
SCARD_PROVIDER_CSP 2	この関数は、暗号化サービスプロバイダーの名前を取得します。
SCARD_PROVIDER_KSP 3	この関数は、スマートカードのキーストレージプロバイダー (KSP) の名前を取得します。
SCARD_PROVIDER_CARD_MODULE 0x80000001	この関数は、カードモジュールの名前を取得します。

szProvider

LPWSTR

out

この関数が正常に完了したときにプロバイダー名を受け取る文字列変数です。

pcchProvider

DWORD*

inout

DWORD 値へのポインターです。入力時、pcchProvider は szProvider バッファーの長さを文字数で指定します。この値が SCARD_AUTOALLOCATE の場合、szProvider はバイトポインターへのポインターに変換され、文字列を格納したメモリブロックのアドレスを受け取ります。このメモリブロックは SCardFreeMemory を呼び出して解放する必要があります。

出力時、この値は szProvider 変数に格納された、null 終端文字を含む実際の文字数を表します。

戻り値の型: INT

公式ドキュメント

指定したカード名とプロバイダー種別に対応するプロバイダーを含むモジュール (ダイナミックリンクライブラリ) の名前を返します。(Unicode)

戻り値

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

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

解説(Remarks)

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

この関数が正常に完了すると、szProvider の値を CryptAcquireContext の呼び出しで 3 番目のパラメーターとして使用できます。

例

次の例は、指定したリーダーコンテキストのプロバイダー名を取得する方法を示しています。この例では、hContext が事前の SCardEstablishContext 関数の呼び出しで取得した有効なハンドルであることを前提としています。

LPTSTR szProvider = NULL;
LPTSTR szCardName = _T("WindowsCard");
DWORD  chProvider = SCARD_AUTOALLOCATE;
LONG   lReturn = SCARD_S_SUCCESS;

// Retrieve the provider name.
// hContext was set by SCardEstablishContext.
lReturn = SCardGetCardTypeProviderName(hContext,
                                       szCardName,
                                       SCARD_PROVIDER_CSP,
                                       (LPTSTR)&szProvider,
                                       &chProvider);
if (SCARD_S_SUCCESS == lReturn)
{
    BOOL fSts = TRUE;
    HCRYPTPROV hProv = NULL;
  
  // Acquire a Cryptographic operation context.
    fSts = CryptAcquireContext(&hProv,
                               NULL,
                               szProvider,
                               PROV_RSA_FULL,
                               0);
    // Perform Cryptographic operations with smart card
    // ...

    // Free memory allocated by SCardGetCardTypeProviderName.
    lReturn = SCardFreeMemory(hContext, szProvider);
}

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SCardGetCardTypeProviderNameW(
    UINT_PTR hContext,
    LPCWSTR szCardName,
    DWORD dwProviderId,
    LPWSTR szProvider,
    DWORD* pcchProvider
);

[DllImport("WinSCard.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int SCardGetCardTypeProviderNameW(
    UIntPtr hContext,   // UINT_PTR
    [MarshalAs(UnmanagedType.LPWStr)] string szCardName,   // LPCWSTR
    uint dwProviderId,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szProvider,   // LPWSTR out
    ref uint pcchProvider   // DWORD* in/out
);

<DllImport("WinSCard.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SCardGetCardTypeProviderNameW(
    hContext As UIntPtr,   ' UINT_PTR
    <MarshalAs(UnmanagedType.LPWStr)> szCardName As String,   ' LPCWSTR
    dwProviderId As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> szProvider As System.Text.StringBuilder,   ' LPWSTR out
    ByRef pcchProvider As UInteger   ' DWORD* in/out
) As Integer
End Function

' hContext : UINT_PTR
' szCardName : LPCWSTR
' dwProviderId : DWORD
' szProvider : LPWSTR out
' pcchProvider : DWORD* in/out
Declare PtrSafe Function SCardGetCardTypeProviderNameW Lib "winscard" ( _
    ByVal hContext As LongPtr, _
    ByVal szCardName As LongPtr, _
    ByVal dwProviderId As Long, _
    ByVal szProvider As LongPtr, _
    ByRef pcchProvider 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

SCardGetCardTypeProviderNameW = ctypes.windll.winscard.SCardGetCardTypeProviderNameW
SCardGetCardTypeProviderNameW.restype = ctypes.c_int
SCardGetCardTypeProviderNameW.argtypes = [
    ctypes.c_size_t,  # hContext : UINT_PTR
    wintypes.LPCWSTR,  # szCardName : LPCWSTR
    wintypes.DWORD,  # dwProviderId : DWORD
    wintypes.LPWSTR,  # szProvider : LPWSTR out
    ctypes.POINTER(wintypes.DWORD),  # pcchProvider : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WinSCard.dll')
SCardGetCardTypeProviderNameW = Fiddle::Function.new(
  lib['SCardGetCardTypeProviderNameW'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hContext : UINT_PTR
    Fiddle::TYPE_VOIDP,  # szCardName : LPCWSTR
    -Fiddle::TYPE_INT,  # dwProviderId : DWORD
    Fiddle::TYPE_VOIDP,  # szProvider : LPWSTR out
    Fiddle::TYPE_VOIDP,  # pcchProvider : DWORD* in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "winscard")]
extern "system" {
    fn SCardGetCardTypeProviderNameW(
        hContext: usize,  // UINT_PTR
        szCardName: *const u16,  // LPCWSTR
        dwProviderId: u32,  // DWORD
        szProvider: *mut u16,  // LPWSTR out
        pcchProvider: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WinSCard.dll", CharSet = CharSet.Unicode)]
public static extern int SCardGetCardTypeProviderNameW(UIntPtr hContext, [MarshalAs(UnmanagedType.LPWStr)] string szCardName, uint dwProviderId, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szProvider, ref uint pcchProvider);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WinSCard_SCardGetCardTypeProviderNameW' -Namespace Win32 -PassThru
# $api::SCardGetCardTypeProviderNameW(hContext, szCardName, dwProviderId, szProvider, pcchProvider)

#uselib "WinSCard.dll"
#func global SCardGetCardTypeProviderNameW "SCardGetCardTypeProviderNameW" wptr, wptr, wptr, wptr, wptr
; SCardGetCardTypeProviderNameW hContext, szCardName, dwProviderId, varptr(szProvider), varptr(pcchProvider)   ; 戻り値は stat
; hContext : UINT_PTR -> "wptr"
; szCardName : LPCWSTR -> "wptr"
; dwProviderId : DWORD -> "wptr"
; szProvider : LPWSTR out -> "wptr"
; pcchProvider : DWORD* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WinSCard.dll"
#cfunc global SCardGetCardTypeProviderNameW "SCardGetCardTypeProviderNameW" sptr, wstr, int, var, var
; res = SCardGetCardTypeProviderNameW(hContext, szCardName, dwProviderId, szProvider, pcchProvider)
; hContext : UINT_PTR -> "sptr"
; szCardName : LPCWSTR -> "wstr"
; dwProviderId : DWORD -> "int"
; szProvider : LPWSTR out -> "var"
; pcchProvider : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WinSCard.dll"
#cfunc global SCardGetCardTypeProviderNameW "SCardGetCardTypeProviderNameW" sptr, wstr, int, sptr, sptr
; res = SCardGetCardTypeProviderNameW(hContext, szCardName, dwProviderId, varptr(szProvider), varptr(pcchProvider))
; hContext : UINT_PTR -> "sptr"
; szCardName : LPCWSTR -> "wstr"
; dwProviderId : DWORD -> "int"
; szProvider : LPWSTR out -> "sptr"
; pcchProvider : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。