Win32 API 日本語リファレンス
ホームSecurity.Credentials › SCardBeginTransaction

SCardBeginTransaction

関数
スマートカードへのトランザクションを開始する。
DLLWinSCard.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

INT SCardBeginTransaction(
    UINT_PTR hCard
);

パラメーター

名前方向説明
hCardUINT_PTRin以前の SCardConnect の呼び出しから取得した参照値です。

戻り値の型: INT

公式ドキュメント

トランザクションを開始します。

戻り値

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

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

別のプロセスまたはスレッドがカードをリセットした場合は、想定どおり SCARD_W_RESET_CARD が返されます。

Windows Server 2008 R2、Windows 7、Windows Server 2008、Windows Vista、Windows Server 2003、および Windows XP: これらのプラットフォームでは、別のプロセスまたはスレッドがカードをリセットした場合でも、この関数は SCARD_S_SUCCESS を返します。カードがリセットされたかどうかを判断するには、この関数を呼び出した直後に SCardStatus 関数を呼び出してください。

解説(Remarks)

カードに対して操作が行われないまま 5 秒を超えてトランザクションが保持されると、カードはリセットされます。トランザクション中のカードに対して スマートカードおよびリーダーアクセス関数 または ダイレクトカードアクセス関数 のいずれかを呼び出すと、タイマーがリセットされ、引き続きトランザクションを使用できるようになります。

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

次の例では、スマートカードトランザクションを開始する方法を示します。この例では、lReturnLONG 型の既存の変数であり、hCard が以前の SCardConnect の呼び出しで受け取った有効なハンドルであることを前提としています。


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

各言語での呼び出し定義

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

INT SCardBeginTransaction(
    UINT_PTR hCard
);
[DllImport("WinSCard.dll", ExactSpelling = true)]
static extern int SCardBeginTransaction(
    UIntPtr hCard   // UINT_PTR
);
<DllImport("WinSCard.dll", ExactSpelling:=True)>
Public Shared Function SCardBeginTransaction(
    hCard As UIntPtr   ' UINT_PTR
) As Integer
End Function
' hCard : UINT_PTR
Declare PtrSafe Function SCardBeginTransaction Lib "winscard" ( _
    ByVal hCard As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SCardBeginTransaction = ctypes.windll.winscard.SCardBeginTransaction
SCardBeginTransaction.restype = ctypes.c_int
SCardBeginTransaction.argtypes = [
    ctypes.c_size_t,  # hCard : UINT_PTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WinSCard.dll')
SCardBeginTransaction = Fiddle::Function.new(
  lib['SCardBeginTransaction'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hCard : UINT_PTR
  ],
  Fiddle::TYPE_INT)
#[link(name = "winscard")]
extern "system" {
    fn SCardBeginTransaction(
        hCard: usize  // UINT_PTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WinSCard.dll")]
public static extern int SCardBeginTransaction(UIntPtr hCard);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WinSCard_SCardBeginTransaction' -Namespace Win32 -PassThru
# $api::SCardBeginTransaction(hCard)
#uselib "WinSCard.dll"
#func global SCardBeginTransaction "SCardBeginTransaction" sptr
; SCardBeginTransaction hCard   ; 戻り値は stat
; hCard : UINT_PTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WinSCard.dll"
#cfunc global SCardBeginTransaction "SCardBeginTransaction" sptr
; res = SCardBeginTransaction(hCard)
; hCard : UINT_PTR -> "sptr"
; INT SCardBeginTransaction(UINT_PTR hCard)
#uselib "WinSCard.dll"
#cfunc global SCardBeginTransaction "SCardBeginTransaction" intptr
; res = SCardBeginTransaction(hCard)
; hCard : UINT_PTR -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winscard = windows.NewLazySystemDLL("WinSCard.dll")
	procSCardBeginTransaction = winscard.NewProc("SCardBeginTransaction")
)

// hCard (UINT_PTR)
r1, _, err := procSCardBeginTransaction.Call(
	uintptr(hCard),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function SCardBeginTransaction(
  hCard: NativeUInt   // UINT_PTR
): Integer; stdcall;
  external 'WinSCard.dll' name 'SCardBeginTransaction';
result := DllCall("WinSCard\SCardBeginTransaction"
    , "UPtr", hCard   ; UINT_PTR
    , "Int")   ; return: INT
●SCardBeginTransaction(hCard) = DLL("WinSCard.dll", "int SCardBeginTransaction(int)")
# 呼び出し: SCardBeginTransaction(hCard)
# hCard : UINT_PTR -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "winscard" fn SCardBeginTransaction(
    hCard: usize // UINT_PTR
) callconv(std.os.windows.WINAPI) i32;
proc SCardBeginTransaction(
    hCard: uint  # UINT_PTR
): int32 {.importc: "SCardBeginTransaction", stdcall, dynlib: "WinSCard.dll".}
pragma(lib, "winscard");
extern(Windows)
int SCardBeginTransaction(
    size_t hCard   // UINT_PTR
);
ccall((:SCardBeginTransaction, "WinSCard.dll"), stdcall, Int32,
      (Csize_t,),
      hCard)
# hCard : UINT_PTR -> Csize_t
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SCardBeginTransaction(
    uintptr_t hCard);
]]
local winscard = ffi.load("winscard")
-- winscard.SCardBeginTransaction(hCard)
-- hCard : UINT_PTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WinSCard.dll');
const SCardBeginTransaction = lib.func('__stdcall', 'SCardBeginTransaction', 'int32_t', ['uintptr_t']);
// SCardBeginTransaction(hCard)
// hCard : UINT_PTR -> 'uintptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WinSCard.dll", {
  SCardBeginTransaction: { parameters: ["usize"], result: "i32" },
});
// lib.symbols.SCardBeginTransaction(hCard)
// hCard : UINT_PTR -> "usize"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SCardBeginTransaction(
    size_t hCard);
C, "WinSCard.dll");
// $ffi->SCardBeginTransaction(hCard);
// hCard : UINT_PTR
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Winscard extends StdCallLibrary {
    Winscard INSTANCE = Native.load("winscard", Winscard.class);
    int SCardBeginTransaction(
        long hCard   // UINT_PTR
    );
}
@[Link("winscard")]
lib LibWinSCard
  fun SCardBeginTransaction = SCardBeginTransaction(
    hCard : LibC::SizeT   # UINT_PTR
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SCardBeginTransactionNative = Int32 Function(UintPtr);
typedef SCardBeginTransactionDart = int Function(int);
final SCardBeginTransaction = DynamicLibrary.open('WinSCard.dll')
    .lookupFunction<SCardBeginTransactionNative, SCardBeginTransactionDart>('SCardBeginTransaction');
// hCard : UINT_PTR -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SCardBeginTransaction(
  hCard: NativeUInt   // UINT_PTR
): Integer; stdcall;
  external 'WinSCard.dll' name 'SCardBeginTransaction';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SCardBeginTransaction"
  c_SCardBeginTransaction :: CUIntPtr -> IO Int32
-- hCard : UINT_PTR -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let scardbegintransaction =
  foreign "SCardBeginTransaction"
    (size_t @-> returning int32_t)
(* hCard : UINT_PTR -> size_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winscard (t "WinSCard.dll"))
(cffi:use-foreign-library winscard)

(cffi:defcfun ("SCardBeginTransaction" scard-begin-transaction :convention :stdcall) :int32
  (h-card :uint64))   ; UINT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SCardBeginTransaction = Win32::API::More->new('WinSCard',
    'int SCardBeginTransaction(WPARAM hCard)');
# my $ret = $SCardBeginTransaction->Call($hCard);
# hCard : UINT_PTR -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目