ホーム › Security.Credentials › SCardGetProviderIdA

SCardGetProviderIdA

関数

指定カードのプライマリプロバイダーのGUIDを取得する。

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

シグネチャ

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

INT SCardGetProviderIdA(
    UINT_PTR hContext,
    LPCSTR szCard,
    GUID* pguidProviderId
);

パラメーター

名前	型	方向	説明
hContext	UINT_PTR	in	クエリ対象のリソースマネージャーコンテキストを識別するハンドル。リソースマネージャーコンテキストは、事前に SCardEstablishContext を呼び出すことで設定できます。このパラメーターを NULL にすることはできません。
szCard	LPCSTR	in	システムに定義されているカードの名前。
pguidProviderId	GUID*	out	プライマリサービスプロバイダーの識別子 (GUID)。このプロバイダーは COM を使用してアクティブ化でき、カード内の他のサービスへのアクセスを提供します。

戻り値の型: INT

公式ドキュメント

指定したカードのプライマリサービスプロバイダーの識別子 (GUID) を返します。(ANSI)

戻り値

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

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

解説(Remarks)

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

SCardGetProviderId 関数はデータベースクエリ関数です。その他のデータベースクエリ関数の詳細については、スマートカードデータベースクエリ関数を参照してください。

使用例

次の例は、指定したカードのプロバイダー ID を取得する方法を示しています。この例では、hContext が事前の SCardEstablishContext 関数の呼び出しで取得した有効なハンドルであり、"MyCardName" が事前の SCardIntroduceCardType 関数の呼び出しで登録済みであることを前提としています。

GUID    guidProv;
LONG    lReturn;

lReturn = SCardGetProviderId(hContext, 
                             L"MyCardName",
                             &guidProv);
if ( SCARD_S_SUCCESS != lReturn )
    printf("Failed SCardGetProviderId - %x\n", lReturn);
else
{
    // Use the provider GUID as needed.
    // ...
}

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SCardGetProviderIdA(
    UINT_PTR hContext,
    LPCSTR szCard,
    GUID* pguidProviderId
);

[DllImport("WinSCard.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int SCardGetProviderIdA(
    UIntPtr hContext,   // UINT_PTR
    [MarshalAs(UnmanagedType.LPStr)] string szCard,   // LPCSTR
    out Guid pguidProviderId   // GUID* out
);

<DllImport("WinSCard.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SCardGetProviderIdA(
    hContext As UIntPtr,   ' UINT_PTR
    <MarshalAs(UnmanagedType.LPStr)> szCard As String,   ' LPCSTR
    <Out> ByRef pguidProviderId As Guid   ' GUID* out
) As Integer
End Function

' hContext : UINT_PTR
' szCard : LPCSTR
' pguidProviderId : GUID* out
Declare PtrSafe Function SCardGetProviderIdA Lib "winscard" ( _
    ByVal hContext As LongPtr, _
    ByVal szCard As String, _
    ByVal pguidProviderId As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SCardGetProviderIdA = ctypes.windll.winscard.SCardGetProviderIdA
SCardGetProviderIdA.restype = ctypes.c_int
SCardGetProviderIdA.argtypes = [
    ctypes.c_size_t,  # hContext : UINT_PTR
    wintypes.LPCSTR,  # szCard : LPCSTR
    ctypes.c_void_p,  # pguidProviderId : GUID* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WinSCard.dll')
SCardGetProviderIdA = Fiddle::Function.new(
  lib['SCardGetProviderIdA'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hContext : UINT_PTR
    Fiddle::TYPE_VOIDP,  # szCard : LPCSTR
    Fiddle::TYPE_VOIDP,  # pguidProviderId : GUID* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "winscard")]
extern "system" {
    fn SCardGetProviderIdA(
        hContext: usize,  // UINT_PTR
        szCard: *const u8,  // LPCSTR
        pguidProviderId: *mut GUID  // GUID* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WinSCard.dll", CharSet = CharSet.Ansi)]
public static extern int SCardGetProviderIdA(UIntPtr hContext, [MarshalAs(UnmanagedType.LPStr)] string szCard, out Guid pguidProviderId);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WinSCard_SCardGetProviderIdA' -Namespace Win32 -PassThru
# $api::SCardGetProviderIdA(hContext, szCard, pguidProviderId)

#uselib "WinSCard.dll"
#func global SCardGetProviderIdA "SCardGetProviderIdA" sptr, sptr, sptr
; SCardGetProviderIdA hContext, szCard, varptr(pguidProviderId)   ; 戻り値は stat
; hContext : UINT_PTR -> "sptr"
; szCard : LPCSTR -> "sptr"
; pguidProviderId : GUID* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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