ホーム › Security.Credentials › SCardUIDlgSelectCardA

SCardUIDlgSelectCardA

関数

スマートカード選択ダイアログを表示する。

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

シグネチャ

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

INT SCardUIDlgSelectCardA(
    OPENCARDNAME_EXA* param0
);

パラメーター

名前	型	方向	説明
param0	OPENCARDNAME_EXA*	inout	カード選択ダイアログの動作を指定するOPENCARDNAME_EXA構造体へのポインタ。選択結果も格納される。

戻り値の型: INT

公式ドキュメント

スマートカードの「カードの選択」ダイアログボックスを表示します。(ANSI)

戻り値

関数が「カードの選択」ダイアログボックスの表示に成功した場合、戻り値は SCARD_S_SUCCESS です。

関数が失敗した場合は、エラーコードを返します。詳細については、 Smart Card Return Values を参照してください。

解説(Remarks)

SCardUIDlgSelectCard 関数は、特定のスマートカードに接続するための手段を提供します。呼び出されると、この関数は pDlgStruc パラメーターで指定された OPENCARD_SEARCH_CRITERIA メンバーに一致する適切なスマートカードを検索します。pDlgStruc の dwFlags メンバーに応じて、この関数は次の動作を行います。

値	動作
SC_DLG_FORCE_UI	スマートカードの Select Card ダイアログボックスでユーザーが選択したカードに接続します。
SC_DLG_MINIMAL_UI	条件を満たすスマートカードが 1 枚のみの場合はそのスマートカードを選択し、条件を満たすスマートカードが複数ある場合はユーザーの選択に関する情報を返します。
SC_DLG_NO_UI	最初に利用可能なカードを選択します。

この関数は GetOpenCardName を置き換えるものです。GetOpenCardName 関数は、Microsoft Smart Card Base Components バージョン 1.0 との下位互換性のために維持されています。

例

次の例は、スマートカードの Select Card ダイアログボックスを表示する方法を示しています。

SCARDCONTEXT     hSC;
OPENCARDNAME_EX  dlgStruct;
WCHAR            szReader[256];
WCHAR            szCard[256];
LONG             lReturn;

// Establish a context.
// It will be assigned to the structure's hSCardContext field.
lReturn = SCardEstablishContext(SCARD_SCOPE_USER,
                                NULL,
                                NULL,
                                &hSC );
if ( SCARD_S_SUCCESS != lReturn )
{
    printf("Failed SCardEstablishContext\n");
    exit(1);
}

// Initialize the structure.
memset(&dlgStruct, 0, sizeof(dlgStruct));
dlgStruct.dwStructSize = sizeof(dlgStruct);
dlgStruct.hSCardContext = hSC;
dlgStruct.dwFlags = SC_DLG_FORCE_UI;
dlgStruct.lpstrRdr = (LPSTR) szReader;
dlgStruct.nMaxRdr = 256;
dlgStruct.lpstrCard = (LPSTR) szCard;
dlgStruct.nMaxCard = 256;
dlgStruct.lpstrTitle = (LPSTR) "My Select Card Title";

// Display the select card dialog box.
lReturn = SCardUIDlgSelectCard(&dlgStruct);
if ( SCARD_S_SUCCESS != lReturn )
    printf("Failed SCardUIDlgSelectCard - %x\n", lReturn );
else
    printf("Reader: %S\nCard: %S\n", szReader, szCard );

// Release the context (by SCardReleaseContext - not shown here).

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

INT SCardUIDlgSelectCardA(
    OPENCARDNAME_EXA* param0
);

[DllImport("SCARDDLG.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int SCardUIDlgSelectCardA(
    IntPtr param0   // OPENCARDNAME_EXA* in/out
);

<DllImport("SCARDDLG.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SCardUIDlgSelectCardA(
    param0 As IntPtr   ' OPENCARDNAME_EXA* in/out
) As Integer
End Function

' param0 : OPENCARDNAME_EXA* in/out
Declare PtrSafe Function SCardUIDlgSelectCardA Lib "scarddlg" ( _
    ByVal param0 As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SCardUIDlgSelectCardA = ctypes.windll.scarddlg.SCardUIDlgSelectCardA
SCardUIDlgSelectCardA.restype = ctypes.c_int
SCardUIDlgSelectCardA.argtypes = [
    ctypes.c_void_p,  # param0 : OPENCARDNAME_EXA* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SCARDDLG.dll')
SCardUIDlgSelectCardA = Fiddle::Function.new(
  lib['SCardUIDlgSelectCardA'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : OPENCARDNAME_EXA* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "scarddlg")]
extern "system" {
    fn SCardUIDlgSelectCardA(
        param0: *mut OPENCARDNAME_EXA  // OPENCARDNAME_EXA* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SCARDDLG.dll", CharSet = CharSet.Ansi)]
public static extern int SCardUIDlgSelectCardA(IntPtr param0);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SCARDDLG_SCardUIDlgSelectCardA' -Namespace Win32 -PassThru
# $api::SCardUIDlgSelectCardA(param0)

#uselib "SCARDDLG.dll"
#func global SCardUIDlgSelectCardA "SCardUIDlgSelectCardA" sptr
; SCardUIDlgSelectCardA varptr(param0)   ; 戻り値は stat
; param0 : OPENCARDNAME_EXA* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SCARDDLG.dll"
#cfunc global SCardUIDlgSelectCardA "SCardUIDlgSelectCardA" var
; res = SCardUIDlgSelectCardA(param0)
; param0 : OPENCARDNAME_EXA* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SCARDDLG.dll"
#cfunc global SCardUIDlgSelectCardA "SCardUIDlgSelectCardA" sptr
; res = SCardUIDlgSelectCardA(varptr(param0))
; param0 : OPENCARDNAME_EXA* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。