ホーム › Security.Credentials › SCardListInterfacesA

SCardListInterfacesA

関数

指定カードがサポートするインターフェイスを列挙する。

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

シグネチャ

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

INT SCardListInterfacesA(
    UINT_PTR hContext,
    LPCSTR szCard,
    GUID* pguidInterfaces,
    DWORD* pcguidInterfaces
);

パラメーター

名前	型	方向	説明
hContext	UINT_PTR	in	クエリ対象のリソースマネージャーコンテキストを識別するハンドルです。リソースマネージャーコンテキストは、事前に SCardEstablishContext を呼び出して設定できます。このパラメーターを NULL にすることはできません。
szCard	LPCSTR	in	スマートカードサブシステムに既に登録されているスマートカードの名前です。
pguidInterfaces	GUID*	out	スマートカードがサポートするインターフェイスを示すインターフェイス識別子 (GUID) の配列です。この値が NULL の場合、SCardListInterfaces は pcguidInterfaces で指定された配列長を無視し、このパラメーターが NULL でなかった場合に返されたであろう配列のサイズを pcguidInterfaces に返し、成功コードを返します。
pcguidInterfaces	DWORD*	inout	pcguidInterfaces 配列のサイズであり、返される配列の実際のサイズを受け取ります。配列サイズに SCARD_AUTOALLOCATE を指定した場合、pcguidInterfaces は GUID ポインターへのポインターに変換され、配列を格納したメモリブロックのアドレスを受け取ります。このメモリブロックは SCardFreeMemory で解放する必要があります。

戻り値の型: INT

公式ドキュメント

指定したカードが提供するインターフェイスの一覧を返します。(ANSI)

戻り値

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

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

解説(Remarks)

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

SCardListInterfaces 関数はデータベースクエリ関数です。その他のデータベースクエリ関数の詳細については、 Smart Card Database Query Functions を参照してください。

例

次の例は、スマートカードのインターフェイスを一覧表示する方法を示しています。

LPGUID          pGuids = NULL;
LONG            lReturn;
DWORD           cGuid = SCARD_AUTOALLOCATE;

// Retrieve the list of interfaces.
lReturn = SCardListInterfaces(NULL,
                              (LPCSTR) "MyCard",
                              (LPGUID)&pGuids,
                              &cGuid );
if ( SCARD_S_SUCCESS != lReturn )
{
    printf("Failed SCardListInterfaces\n");
    exit(1);   // Or other appropriate action
}

if ( 0 != cGuid )
{
    // Do something with the array of Guids.
    // Remember to free pGuids when done (by SCardFreeMemory).
    // ...
}

メモ

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

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

[DllImport("WinSCard.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int SCardListInterfacesA(
    UIntPtr hContext,   // UINT_PTR
    [MarshalAs(UnmanagedType.LPStr)] string szCard,   // LPCSTR
    out Guid pguidInterfaces,   // GUID* out
    ref uint pcguidInterfaces   // DWORD* in/out
);

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

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

import ctypes
from ctypes import wintypes

SCardListInterfacesA = ctypes.windll.winscard.SCardListInterfacesA
SCardListInterfacesA.restype = ctypes.c_int
SCardListInterfacesA.argtypes = [
    ctypes.c_size_t,  # hContext : UINT_PTR
    wintypes.LPCSTR,  # szCard : LPCSTR
    ctypes.c_void_p,  # pguidInterfaces : GUID* out
    ctypes.POINTER(wintypes.DWORD),  # pcguidInterfaces : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WinSCard.dll')
SCardListInterfacesA = Fiddle::Function.new(
  lib['SCardListInterfacesA'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hContext : UINT_PTR
    Fiddle::TYPE_VOIDP,  # szCard : LPCSTR
    Fiddle::TYPE_VOIDP,  # pguidInterfaces : GUID* out
    Fiddle::TYPE_VOIDP,  # pcguidInterfaces : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "winscard")]
extern "system" {
    fn SCardListInterfacesA(
        hContext: usize,  // UINT_PTR
        szCard: *const u8,  // LPCSTR
        pguidInterfaces: *mut GUID,  // GUID* out
        pcguidInterfaces: *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 SCardListInterfacesA(UIntPtr hContext, [MarshalAs(UnmanagedType.LPStr)] string szCard, out Guid pguidInterfaces, ref uint pcguidInterfaces);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WinSCard_SCardListInterfacesA' -Namespace Win32 -PassThru
# $api::SCardListInterfacesA(hContext, szCard, pguidInterfaces, pcguidInterfaces)

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

出力引数:

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