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

SCardForgetReaderA

関数
登録済みのスマートカードリーダーを削除する。
DLLWinSCard.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

INT SCardForgetReaderA(
    UINT_PTR hContext,
    LPCSTR szReaderName
);

パラメーター

名前方向説明
hContextUINT_PTRinリソースマネージャーコンテキストを識別するハンドルです。リソースマネージャーコンテキストは、事前の SCardEstablishContext の呼び出しによって設定されます。このパラメーターを NULL にすることはできません。
szReaderNameLPCSTRinスマートカードデータベースから削除するリーダーの表示名です。

戻り値の型: INT

公式ドキュメント

以前に登録したリーダーをスマートカードサブシステムの管理対象から削除します。リーダーは、追加されている可能性のあるすべてのリーダーグループを含め、スマートカードデータベースから削除されます。(ANSI)

戻り値

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

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

解説(Remarks)

指定したリーダーがリーダーグループの最後のメンバーである場合、そのリーダーグループも自動的に削除されます。

SCardForgetReader 関数はデータベース管理関数です。その他のデータベース管理関数の詳細については、 Smart Card Database Management Functions を参照してください。

次の例は、指定したカードリーダーの表示名をシステムから削除します。この例では、lReturn が LONG 型の有効な変数であり、hContext が事前の SCardEstablishContext 関数の呼び出しから受け取った有効なハンドルであることを前提としています。


lReturn = SCardForgetReader(hContext, 
                            TEXT("MyReader"));
if ( SCARD_S_SUCCESS != lReturn )
    printf("Failed SCardForgetReader\n");
メモ

winscard.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SCardForgetReader を定義します。エンコーディング非依存のエイリアスの使用と、エンコーディング非依存でないコードを混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、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 SCardForgetReaderA(
    UINT_PTR hContext,
    LPCSTR szReaderName
);
[DllImport("WinSCard.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int SCardForgetReaderA(
    UIntPtr hContext,   // UINT_PTR
    [MarshalAs(UnmanagedType.LPStr)] string szReaderName   // LPCSTR
);
<DllImport("WinSCard.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SCardForgetReaderA(
    hContext As UIntPtr,   ' UINT_PTR
    <MarshalAs(UnmanagedType.LPStr)> szReaderName As String   ' LPCSTR
) As Integer
End Function
' hContext : UINT_PTR
' szReaderName : LPCSTR
Declare PtrSafe Function SCardForgetReaderA Lib "winscard" ( _
    ByVal hContext As LongPtr, _
    ByVal szReaderName As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SCardForgetReaderA = ctypes.windll.winscard.SCardForgetReaderA
SCardForgetReaderA.restype = ctypes.c_int
SCardForgetReaderA.argtypes = [
    ctypes.c_size_t,  # hContext : UINT_PTR
    wintypes.LPCSTR,  # szReaderName : LPCSTR
]
require 'fiddle'
require 'fiddle/import'

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

var (
	winscard = windows.NewLazySystemDLL("WinSCard.dll")
	procSCardForgetReaderA = winscard.NewProc("SCardForgetReaderA")
)

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

extern "winscard" fn SCardForgetReaderA(
    hContext: usize, // UINT_PTR
    szReaderName: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) i32;
proc SCardForgetReaderA(
    hContext: uint,  # UINT_PTR
    szReaderName: cstring  # LPCSTR
): int32 {.importc: "SCardForgetReaderA", stdcall, dynlib: "WinSCard.dll".}
pragma(lib, "winscard");
extern(Windows)
int SCardForgetReaderA(
    size_t hContext,   // UINT_PTR
    const(char)* szReaderName   // LPCSTR
);
ccall((:SCardForgetReaderA, "WinSCard.dll"), stdcall, Int32,
      (Csize_t, Cstring),
      hContext, szReaderName)
# hContext : UINT_PTR -> Csize_t
# szReaderName : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SCardForgetReaderA(
    uintptr_t hContext,
    const char* szReaderName);
]]
local winscard = ffi.load("winscard")
-- winscard.SCardForgetReaderA(hContext, szReaderName)
-- hContext : UINT_PTR
-- szReaderName : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WinSCard.dll');
const SCardForgetReaderA = lib.func('__stdcall', 'SCardForgetReaderA', 'int32_t', ['uintptr_t', 'str']);
// SCardForgetReaderA(hContext, szReaderName)
// hContext : UINT_PTR -> 'uintptr_t'
// szReaderName : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WinSCard.dll", {
  SCardForgetReaderA: { parameters: ["usize", "buffer"], result: "i32" },
});
// lib.symbols.SCardForgetReaderA(hContext, szReaderName)
// hContext : UINT_PTR -> "usize"
// szReaderName : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SCardForgetReaderA(
    size_t hContext,
    const char* szReaderName);
C, "WinSCard.dll");
// $ffi->SCardForgetReaderA(hContext, szReaderName);
// hContext : UINT_PTR
// szReaderName : LPCSTR
// 構造体/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, W32APIOptions.ASCII_OPTIONS);
    int SCardForgetReaderA(
        long hContext,   // UINT_PTR
        String szReaderName   // LPCSTR
    );
}
@[Link("winscard")]
lib LibWinSCard
  fun SCardForgetReaderA = SCardForgetReaderA(
    hContext : LibC::SizeT,   # UINT_PTR
    szReaderName : UInt8*   # LPCSTR
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

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

(cffi:defcfun ("SCardForgetReaderA" scard-forget-reader-a :convention :stdcall) :int32
  (h-context :uint64)   ; UINT_PTR
  (sz-reader-name :string))   ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SCardForgetReaderA = Win32::API::More->new('WinSCard',
    'int SCardForgetReaderA(WPARAM hContext, LPCSTR szReaderName)');
# my $ret = $SCardForgetReaderA->Call($hContext, $szReaderName);
# hContext : UINT_PTR -> WPARAM
# szReaderName : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目