ホーム › Security.Credentials › SCardGetCardTypeProviderNameA

SCardGetCardTypeProviderNameA

関数

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

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

シグネチャ

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

INT SCardGetCardTypeProviderNameA(
    UINT_PTR hContext,
    LPCSTR szCardName,
    DWORD dwProviderId,
    LPSTR szProvider,
    DWORD* pcchProvider
);

パラメーター

名前

型

方向

説明

hContext

UINT_PTR

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

szCardName

LPCSTR

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

dwProviderId

DWORD

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

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

szProvider

LPSTR

out

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

pcchProvider

DWORD*

inout

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

出力時、この値は szProvider 変数内の null 終端文字を含む実際の文字数を表します。

戻り値の型: INT

公式ドキュメント

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

戻り値

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

戻り値	説明
成功	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  (ANSI / -A)
#include <windows.h>

INT SCardGetCardTypeProviderNameA(
    UINT_PTR hContext,
    LPCSTR szCardName,
    DWORD dwProviderId,
    LPSTR szProvider,
    DWORD* pcchProvider
);

[DllImport("WinSCard.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int SCardGetCardTypeProviderNameA(
    UIntPtr hContext,   // UINT_PTR
    [MarshalAs(UnmanagedType.LPStr)] string szCardName,   // LPCSTR
    uint dwProviderId,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szProvider,   // LPSTR out
    ref uint pcchProvider   // DWORD* in/out
);

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

' hContext : UINT_PTR
' szCardName : LPCSTR
' dwProviderId : DWORD
' szProvider : LPSTR out
' pcchProvider : DWORD* in/out
Declare PtrSafe Function SCardGetCardTypeProviderNameA Lib "winscard" ( _
    ByVal hContext As LongPtr, _
    ByVal szCardName As String, _
    ByVal dwProviderId As Long, _
    ByVal szProvider As String, _
    ByRef pcchProvider As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WinSCard.dll')
SCardGetCardTypeProviderNameA = Fiddle::Function.new(
  lib['SCardGetCardTypeProviderNameA'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hContext : UINT_PTR
    Fiddle::TYPE_VOIDP,  # szCardName : LPCSTR
    -Fiddle::TYPE_INT,  # dwProviderId : DWORD
    Fiddle::TYPE_VOIDP,  # szProvider : LPSTR out
    Fiddle::TYPE_VOIDP,  # pcchProvider : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

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

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

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

出力引数:

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