SCardForgetReaderGroupA function (winscard.h)
The SCardForgetReaderGroup function removes a previously introduced smart card reader group from the smart card subsystem. Although this function automatically clears all readers from the group, it does not affect the existence of the individual readers in the database.
Syntax
LONG SCardForgetReaderGroupA(
[in] SCARDCONTEXT hContext,
[in] LPCSTR szGroupName
);
Parameters
[in] hContext
Handle that identifies the resource manager context. The resource manager context is set by a previous call to SCardEstablishContext. This parameter cannot be NULL.
[in] szGroupName
Display name of the reader group to be removed. System-defined reader groups cannot be removed from the database.
Return value
This function returns different values depending on whether it succeeds or fails.
Return code | Description |
---|---|
|
SCARD_S_SUCCESS. |
|
An error code. For more information, see Smart Card Return Values. |
Remarks
The SCardForgetReaderGroup function is a database management function. For more information on other database management functions, see Smart Card Database Management Functions.
Examples
The following example shows how to remove a reader group from the system. The example assumes that lReturn is an existing variable of type LONG, and that hContext is a valid handle to a resource manager context previously obtained from a call to the SCardEstablishContext function.
lReturn = SCardForgetReaderGroup(hContext,
L"MyReaderGroup");
if ( SCARD_S_SUCCESS != lReturn )
printf("Failed SCardForgetReaderGroup\n");
Note
The winscard.h header defines SCardForgetReaderGroup as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.
Requirements
Requirement | Value |
---|---|
Minimum supported client | Windows XP [desktop apps only] |
Minimum supported server | Windows Server 2003 [desktop apps only] |
Target Platform | Windows |
Header | winscard.h |
Library | Winscard.lib |
DLL | Winscard.dll |