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

SCardForgetReaderGroupA

関数
登録済みのリーダーグループをシステムから削除する。
DLLWinSCard.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

INT SCardForgetReaderGroupA(
    UINT_PTR hContext,
    LPCSTR szGroupName
);

パラメーター

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

削除するリーダーグループの表示名です。システム定義のリーダーグループはデータベースから削除できません。

意味
SCARD_ALL_READERS
TEXT("SCard$AllReaders\000")
リーダーを列挙する際にグループ名が指定されなかった場合に使用されるグループです。リーダーが属するグループに関係なく、すべてのリーダーの一覧を返します。
SCARD_DEFAULT_READERS
TEXT("SCard$DefaultReaders\000")
リーダーがシステムに登録された際に追加される既定のグループです。
SCARD_LOCAL_READERS
TEXT("SCard$LocalReaders\000")
使用されていないレガシー値です。これは内部で管理されるグループであり、いずれのリーダーグループ API を使用しても変更できません。列挙のみを目的として使用されます。
SCARD_SYSTEM_READERS
TEXT("SCard$SystemReaders\000")
使用されていないレガシー値です。これは内部で管理されるグループであり、いずれのリーダーグループ API を使用しても変更できません。列挙のみを目的として使用されます。

戻り値の型: INT

公式ドキュメント

以前に登録されたスマートカードリーダーグループをスマートカードサブシステムから削除します。この関数はグループからすべてのリーダーを自動的にクリアしますが、データベース内の個々のリーダーの存在には影響しません。(ANSI)

戻り値

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

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

解説(Remarks)

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

次の例は、システムからリーダーグループを削除する方法を示しています。この例では、lReturn が LONG 型の既存の変数であり、hContext が以前に SCardEstablishContext 関数の呼び出しから取得した有効なリソースマネージャーコンテキストのハンドルであることを前提としています。


lReturn = SCardForgetReaderGroup(hContext, 
                                 L"MyReaderGroup");
if ( SCARD_S_SUCCESS != lReturn )
    printf("Failed SCardForgetReaderGroup\n");
メモ

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

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

lib = Fiddle.dlopen('WinSCard.dll')
SCardForgetReaderGroupA = Fiddle::Function.new(
  lib['SCardForgetReaderGroupA'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hContext : UINT_PTR
    Fiddle::TYPE_VOIDP,  # szGroupName : LPCSTR
  ],
  Fiddle::TYPE_INT)
#[link(name = "winscard")]
extern "system" {
    fn SCardForgetReaderGroupA(
        hContext: usize,  // UINT_PTR
        szGroupName: *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 SCardForgetReaderGroupA(UIntPtr hContext, [MarshalAs(UnmanagedType.LPStr)] string szGroupName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WinSCard_SCardForgetReaderGroupA' -Namespace Win32 -PassThru
# $api::SCardForgetReaderGroupA(hContext, szGroupName)
#uselib "WinSCard.dll"
#func global SCardForgetReaderGroupA "SCardForgetReaderGroupA" sptr, sptr
; SCardForgetReaderGroupA hContext, szGroupName   ; 戻り値は stat
; hContext : UINT_PTR -> "sptr"
; szGroupName : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WinSCard.dll"
#cfunc global SCardForgetReaderGroupA "SCardForgetReaderGroupA" sptr, str
; res = SCardForgetReaderGroupA(hContext, szGroupName)
; hContext : UINT_PTR -> "sptr"
; szGroupName : LPCSTR -> "str"
; INT SCardForgetReaderGroupA(UINT_PTR hContext, LPCSTR szGroupName)
#uselib "WinSCard.dll"
#cfunc global SCardForgetReaderGroupA "SCardForgetReaderGroupA" intptr, str
; res = SCardForgetReaderGroupA(hContext, szGroupName)
; hContext : UINT_PTR -> "intptr"
; szGroupName : LPCSTR -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winscard = windows.NewLazySystemDLL("WinSCard.dll")
	procSCardForgetReaderGroupA = winscard.NewProc("SCardForgetReaderGroupA")
)

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

extern "winscard" fn SCardForgetReaderGroupA(
    hContext: usize, // UINT_PTR
    szGroupName: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) i32;
proc SCardForgetReaderGroupA(
    hContext: uint,  # UINT_PTR
    szGroupName: cstring  # LPCSTR
): int32 {.importc: "SCardForgetReaderGroupA", stdcall, dynlib: "WinSCard.dll".}
pragma(lib, "winscard");
extern(Windows)
int SCardForgetReaderGroupA(
    size_t hContext,   // UINT_PTR
    const(char)* szGroupName   // LPCSTR
);
ccall((:SCardForgetReaderGroupA, "WinSCard.dll"), stdcall, Int32,
      (Csize_t, Cstring),
      hContext, szGroupName)
# hContext : UINT_PTR -> Csize_t
# szGroupName : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SCardForgetReaderGroupA(
    uintptr_t hContext,
    const char* szGroupName);
]]
local winscard = ffi.load("winscard")
-- winscard.SCardForgetReaderGroupA(hContext, szGroupName)
-- hContext : UINT_PTR
-- szGroupName : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WinSCard.dll');
const SCardForgetReaderGroupA = lib.func('__stdcall', 'SCardForgetReaderGroupA', 'int32_t', ['uintptr_t', 'str']);
// SCardForgetReaderGroupA(hContext, szGroupName)
// hContext : UINT_PTR -> 'uintptr_t'
// szGroupName : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WinSCard.dll", {
  SCardForgetReaderGroupA: { parameters: ["usize", "buffer"], result: "i32" },
});
// lib.symbols.SCardForgetReaderGroupA(hContext, szGroupName)
// hContext : UINT_PTR -> "usize"
// szGroupName : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SCardForgetReaderGroupA(
    size_t hContext,
    const char* szGroupName);
C, "WinSCard.dll");
// $ffi->SCardForgetReaderGroupA(hContext, szGroupName);
// hContext : UINT_PTR
// szGroupName : 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 SCardForgetReaderGroupA(
        long hContext,   // UINT_PTR
        String szGroupName   // LPCSTR
    );
}
@[Link("winscard")]
lib LibWinSCard
  fun SCardForgetReaderGroupA = SCardForgetReaderGroupA(
    hContext : LibC::SizeT,   # UINT_PTR
    szGroupName : 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 SCardForgetReaderGroupANative = Int32 Function(UintPtr, Pointer<Utf8>);
typedef SCardForgetReaderGroupADart = int Function(int, Pointer<Utf8>);
final SCardForgetReaderGroupA = DynamicLibrary.open('WinSCard.dll')
    .lookupFunction<SCardForgetReaderGroupANative, SCardForgetReaderGroupADart>('SCardForgetReaderGroupA');
// hContext : UINT_PTR -> UintPtr
// szGroupName : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SCardForgetReaderGroupA(
  hContext: NativeUInt;   // UINT_PTR
  szGroupName: PAnsiChar   // LPCSTR
): Integer; stdcall;
  external 'WinSCard.dll' name 'SCardForgetReaderGroupA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

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

関連項目

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