ホーム › Security.Credentials › SCardConnectW

SCardConnectW

関数

指定リーダーのスマートカードへ接続する。

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

シグネチャ

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

INT SCardConnectW(
    UINT_PTR hContext,
    LPCWSTR szReader,
    DWORD dwShareMode,
    DWORD dwPreferredProtocols,
    UINT_PTR* phCard,
    DWORD* pdwActiveProtocol
);

パラメーター

名前

型

方向

説明

hContext

UINT_PTR

リソースマネージャーコンテキストを識別するハンドル。リソースマネージャーコンテキストは、事前の SCardEstablishContextの呼び出しによって設定されます。

szReader

LPCWSTR

対象カードが挿入されているリーダーの名前。

dwShareMode

DWORD

他のアプリケーションがこのカードへの接続を確立できるかどうかを示すフラグ。

値	意味
SCARD_SHARE_SHARED	このアプリケーションは、カードを他のアプリケーションと共有します。
SCARD_SHARE_EXCLUSIVE	このアプリケーションは、カードを他のアプリケーションと共有しません。
SCARD_SHARE_DIRECT	このアプリケーションは、リーダーを専有して直接制御します。他のアプリケーションからのアクセスは一切許可されません。

dwPreferredProtocols

DWORD

接続に使用できるプロトコルを示すビットマスク。指定可能な値はOR演算で組み合わせることができます。

値	意味
SCARD_PROTOCOL_T0	T=0を使用可能なプロトコルとします。
SCARD_PROTOCOL_T1	T=1を使用可能なプロトコルとします。
0	このパラメーターを 0 にできるのは、dwShareModeに SCARD_SHARE_DIRECT が設定されている場合のみです。この場合、SCardControlで IOCTL_SMARTCARD_SET_PROTOCOL 制御指示が送信されるまで、ドライバーによるプロトコルネゴシエーションは行われません。

phCard

UINT_PTR*

out

指定されたリーダー内のスマートカードへの接続を識別するハンドル。

pdwActiveProtocol

DWORD*

out

確立されたアクティブなプロトコルを示すフラグ。

値	意味
SCARD_PROTOCOL_T0	T=0がアクティブなプロトコルです。
SCARD_PROTOCOL_T1	T=1がアクティブなプロトコルです。
SCARD_PROTOCOL_UNDEFINED	SCARD_SHARE_DIRECT が指定されているため、プロトコルネゴシエーションは行われていません。リーダーにカードが挿入されていない可能性があります。

戻り値の型: INT

公式ドキュメント

呼び出し元アプリケーションと、特定のリーダーに挿入されているスマートカードとの間に、(特定のリソースマネージャーコンテキストを使用して)接続を確立します。指定されたリーダーにカードが存在しない場合は、エラーが返されます。(Unicode)

戻り値

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

戻り値	説明
成功	SCARD_S_SUCCESS。
失敗	エラーコード。詳細については、 Smart Card Return Valuesを参照してください。
SCARD_E_NOT_READY	リーダーがカードに接続できませんでした。

解説(Remarks)

SCardConnect関数は、スマートカードおよびリーダーへのアクセス関数です。その他のアクセス関数の詳細については、 Smart Card and Reader Access Functionsを参照してください。

例

次の例では、リーダーへの接続を作成します。この例では、hContextが、事前のSCardEstablishContextの呼び出しから取得したSCARDCONTEXT型の有効なハンドルであることを前提としています。

SCARDHANDLE     hCardHandle;
LONG            lReturn;
DWORD           dwAP;

lReturn = SCardConnect( hContext, 
                        (LPCTSTR)"Rainbow Technologies SCR3531 0",
                        SCARD_SHARE_SHARED,
                        SCARD_PROTOCOL_T0 | SCARD_PROTOCOL_T1,
                        &hCardHandle,
                        &dwAP );
if ( SCARD_S_SUCCESS != lReturn )
{
    printf("Failed SCardConnect\n");
    exit(1);  // Or other appropriate action.
}

// Use the connection.
// Display the active protocol.
switch ( dwAP )
{
    case SCARD_PROTOCOL_T0:
        printf("Active protocol T0\n"); 
        break;

    case SCARD_PROTOCOL_T1:
        printf("Active protocol T1\n"); 
        break;

    case SCARD_PROTOCOL_UNDEFINED:
    default:
        printf("Active protocol unnegotiated or unknown\n"); 
        break;
}

// Remember to disconnect (by calling SCardDisconnect).
// ...

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SCardConnectW(
    UINT_PTR hContext,
    LPCWSTR szReader,
    DWORD dwShareMode,
    DWORD dwPreferredProtocols,
    UINT_PTR* phCard,
    DWORD* pdwActiveProtocol
);

[DllImport("WinSCard.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int SCardConnectW(
    UIntPtr hContext,   // UINT_PTR
    [MarshalAs(UnmanagedType.LPWStr)] string szReader,   // LPCWSTR
    uint dwShareMode,   // DWORD
    uint dwPreferredProtocols,   // DWORD
    out UIntPtr phCard,   // UINT_PTR* out
    out uint pdwActiveProtocol   // DWORD* out
);

<DllImport("WinSCard.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SCardConnectW(
    hContext As UIntPtr,   ' UINT_PTR
    <MarshalAs(UnmanagedType.LPWStr)> szReader As String,   ' LPCWSTR
    dwShareMode As UInteger,   ' DWORD
    dwPreferredProtocols As UInteger,   ' DWORD
    <Out> ByRef phCard As UIntPtr,   ' UINT_PTR* out
    <Out> ByRef pdwActiveProtocol As UInteger   ' DWORD* out
) As Integer
End Function

' hContext : UINT_PTR
' szReader : LPCWSTR
' dwShareMode : DWORD
' dwPreferredProtocols : DWORD
' phCard : UINT_PTR* out
' pdwActiveProtocol : DWORD* out
Declare PtrSafe Function SCardConnectW Lib "winscard" ( _
    ByVal hContext As LongPtr, _
    ByVal szReader As LongPtr, _
    ByVal dwShareMode As Long, _
    ByVal dwPreferredProtocols As Long, _
    ByRef phCard As LongPtr, _
    ByRef pdwActiveProtocol 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

SCardConnectW = ctypes.windll.winscard.SCardConnectW
SCardConnectW.restype = ctypes.c_int
SCardConnectW.argtypes = [
    ctypes.c_size_t,  # hContext : UINT_PTR
    wintypes.LPCWSTR,  # szReader : LPCWSTR
    wintypes.DWORD,  # dwShareMode : DWORD
    wintypes.DWORD,  # dwPreferredProtocols : DWORD
    ctypes.POINTER(ctypes.c_size_t),  # phCard : UINT_PTR* out
    ctypes.POINTER(wintypes.DWORD),  # pdwActiveProtocol : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WinSCard.dll')
SCardConnectW = Fiddle::Function.new(
  lib['SCardConnectW'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hContext : UINT_PTR
    Fiddle::TYPE_VOIDP,  # szReader : LPCWSTR
    -Fiddle::TYPE_INT,  # dwShareMode : DWORD
    -Fiddle::TYPE_INT,  # dwPreferredProtocols : DWORD
    Fiddle::TYPE_VOIDP,  # phCard : UINT_PTR* out
    Fiddle::TYPE_VOIDP,  # pdwActiveProtocol : DWORD* out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "winscard")]
extern "system" {
    fn SCardConnectW(
        hContext: usize,  // UINT_PTR
        szReader: *const u16,  // LPCWSTR
        dwShareMode: u32,  // DWORD
        dwPreferredProtocols: u32,  // DWORD
        phCard: *mut usize,  // UINT_PTR* out
        pdwActiveProtocol: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WinSCard.dll", CharSet = CharSet.Unicode)]
public static extern int SCardConnectW(UIntPtr hContext, [MarshalAs(UnmanagedType.LPWStr)] string szReader, uint dwShareMode, uint dwPreferredProtocols, out UIntPtr phCard, out uint pdwActiveProtocol);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WinSCard_SCardConnectW' -Namespace Win32 -PassThru
# $api::SCardConnectW(hContext, szReader, dwShareMode, dwPreferredProtocols, phCard, pdwActiveProtocol)

#uselib "WinSCard.dll"
#func global SCardConnectW "SCardConnectW" wptr, wptr, wptr, wptr, wptr, wptr
; SCardConnectW hContext, szReader, dwShareMode, dwPreferredProtocols, varptr(phCard), varptr(pdwActiveProtocol)   ; 戻り値は stat
; hContext : UINT_PTR -> "wptr"
; szReader : LPCWSTR -> "wptr"
; dwShareMode : DWORD -> "wptr"
; dwPreferredProtocols : DWORD -> "wptr"
; phCard : UINT_PTR* out -> "wptr"
; pdwActiveProtocol : DWORD* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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