ホーム › Security.Credentials › SCardEstablishContext

SCardEstablishContext

関数

スマートカードリソースマネージャーへの接続コンテキストを確立する。

DLLWinSCard.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

// WinSCard.dll
#include <windows.h>

INT SCardEstablishContext(
    SCARD_SCOPE dwScope,
    const void* pvReserved1,   // optional
    const void* pvReserved2,   // optional
    UINT_PTR* phContext
);

パラメーター

名前

型

方向

説明

dwScope

SCARD_SCOPE

リソースマネージャーコンテキストのスコープです。このパラメーターには、次のいずれかの値を指定できます。

値	意味
SCARD_SCOPE_USER	データベース操作はユーザーのドメイン内で実行されます。
SCARD_SCOPE_SYSTEM	データベース操作はシステムのドメイン内で実行されます。呼び出し元のアプリケーションは、すべてのデータベース操作に対して適切なアクセス権を持っている必要があります。

pvReserved1

void*

optional

将来の使用のために予約されており、NULL を指定する必要があります。このパラメーターは、適切な権限を持つ管理アプリケーションが他のユーザーの代理として動作できるようにするためのものです。

pvReserved2

void*

optional

将来の使用のために予約されており、NULL を指定する必要があります。

phContext

UINT_PTR*

out

確立されたリソースマネージャーコンテキストへのハンドルです。このハンドルは、このコンテキスト内で処理を行おうとする他の関数に渡すことができます。

戻り値の型: INT

公式ドキュメント

データベース操作を実行する対象となるリソースマネージャーコンテキスト(スコープ)を確立します。

戻り値

関数が成功した場合、SCARD_S_SUCCESS を返します。

関数が失敗した場合は、エラーコードを返します。詳細については、スマートカードの戻り値を参照してください。

解説(Remarks)

SCardEstablishContext が返すコンテキストハンドルは、データベースのクエリ関数および管理関数で使用できます。詳細については、スマートカードデータベースクエリ関数およびスマートカードデータベース管理関数を参照してください。

確立したリソースマネージャーコンテキストを解放するには、 SCardReleaseContext を使用します。

クライアントが、ターミナルサーバー上で実行されているクライアントセッションなどのリモートセッションでスマートカード操作を試みた際に、使用しているオペレーティングシステムがスマートカードのリダイレクトをサポートしていない場合、この関数は ERROR_BROKEN_PIPE を返します。

例

次の例では、リソースマネージャーコンテキストを確立します。

SCARDCONTEXT    hSC;
LONG            lReturn;
// Establish the context.
lReturn = SCardEstablishContext(SCARD_SCOPE_USER,
                                NULL,
                                NULL,
                                &hSC);
if ( SCARD_S_SUCCESS != lReturn )
    printf("Failed SCardEstablishContext\n");
else
{
    // Use the context as needed. When done,
    // free the context by calling SCardReleaseContext.
    // ...
}

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

各言語での呼び出し定義

// WinSCard.dll
#include <windows.h>

INT SCardEstablishContext(
    SCARD_SCOPE dwScope,
    const void* pvReserved1,   // optional
    const void* pvReserved2,   // optional
    UINT_PTR* phContext
);

[DllImport("WinSCard.dll", ExactSpelling = true)]
static extern int SCardEstablishContext(
    uint dwScope,   // SCARD_SCOPE
    IntPtr pvReserved1,   // void* optional
    IntPtr pvReserved2,   // void* optional
    out UIntPtr phContext   // UINT_PTR* out
);

<DllImport("WinSCard.dll", ExactSpelling:=True)>
Public Shared Function SCardEstablishContext(
    dwScope As UInteger,   ' SCARD_SCOPE
    pvReserved1 As IntPtr,   ' void* optional
    pvReserved2 As IntPtr,   ' void* optional
    <Out> ByRef phContext As UIntPtr   ' UINT_PTR* out
) As Integer
End Function

' dwScope : SCARD_SCOPE
' pvReserved1 : void* optional
' pvReserved2 : void* optional
' phContext : UINT_PTR* out
Declare PtrSafe Function SCardEstablishContext Lib "winscard" ( _
    ByVal dwScope As Long, _
    ByVal pvReserved1 As LongPtr, _
    ByVal pvReserved2 As LongPtr, _
    ByRef phContext As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SCardEstablishContext = ctypes.windll.winscard.SCardEstablishContext
SCardEstablishContext.restype = ctypes.c_int
SCardEstablishContext.argtypes = [
    wintypes.DWORD,  # dwScope : SCARD_SCOPE
    ctypes.POINTER(None),  # pvReserved1 : void* optional
    ctypes.POINTER(None),  # pvReserved2 : void* optional
    ctypes.POINTER(ctypes.c_size_t),  # phContext : UINT_PTR* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WinSCard.dll')
SCardEstablishContext = Fiddle::Function.new(
  lib['SCardEstablishContext'],
  [
    -Fiddle::TYPE_INT,  # dwScope : SCARD_SCOPE
    Fiddle::TYPE_VOIDP,  # pvReserved1 : void* optional
    Fiddle::TYPE_VOIDP,  # pvReserved2 : void* optional
    Fiddle::TYPE_VOIDP,  # phContext : UINT_PTR* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "winscard")]
extern "system" {
    fn SCardEstablishContext(
        dwScope: u32,  // SCARD_SCOPE
        pvReserved1: *const (),  // void* optional
        pvReserved2: *const (),  // void* optional
        phContext: *mut usize  // UINT_PTR* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WinSCard.dll")]
public static extern int SCardEstablishContext(uint dwScope, IntPtr pvReserved1, IntPtr pvReserved2, out UIntPtr phContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WinSCard_SCardEstablishContext' -Namespace Win32 -PassThru
# $api::SCardEstablishContext(dwScope, pvReserved1, pvReserved2, phContext)

#uselib "WinSCard.dll"
#func global SCardEstablishContext "SCardEstablishContext" sptr, sptr, sptr, sptr
; SCardEstablishContext dwScope, pvReserved1, pvReserved2, varptr(phContext)   ; 戻り値は stat
; dwScope : SCARD_SCOPE -> "sptr"
; pvReserved1 : void* optional -> "sptr"
; pvReserved2 : void* optional -> "sptr"
; phContext : UINT_PTR* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WinSCard.dll"
#cfunc global SCardEstablishContext "SCardEstablishContext" int, sptr, sptr, var
; res = SCardEstablishContext(dwScope, pvReserved1, pvReserved2, phContext)
; dwScope : SCARD_SCOPE -> "int"
; pvReserved1 : void* optional -> "sptr"
; pvReserved2 : void* optional -> "sptr"
; phContext : UINT_PTR* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WinSCard.dll"
#cfunc global SCardEstablishContext "SCardEstablishContext" int, sptr, sptr, sptr
; res = SCardEstablishContext(dwScope, pvReserved1, pvReserved2, varptr(phContext))
; dwScope : SCARD_SCOPE -> "int"
; pvReserved1 : void* optional -> "sptr"
; pvReserved2 : void* optional -> "sptr"
; phContext : UINT_PTR* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。