Skip to content

Latest commit

 

History

History
212 lines (161 loc) · 6.64 KB

nf-winscard-scardremovereaderfromgroupw.md

File metadata and controls

212 lines (161 loc) · 6.64 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:winscard.SCardRemoveReaderFromGroupW
SCardRemoveReaderFromGroupW function (winscard.h)
Removes a reader from an existing reader group. This function has no effect on the reader. (Unicode)
SCARD_ALL_READERS
SCARD_DEFAULT_READERS
SCARD_LOCAL_READERS
SCARD_SYSTEM_READERS
SCardRemoveReaderFromGroup
SCardRemoveReaderFromGroup function [Security]
SCardRemoveReaderFromGroupW
_smart_scardremovereaderfromgroup
security.scardremovereaderfromgroup
winscard/SCardRemoveReaderFromGroup
winscard/SCardRemoveReaderFromGroupW
security\scardremovereaderfromgroup.htm
security
a9bdaf16-1a6f-4a84-ab29-3d6df9003ff9
12/05/2018
SCARD_ALL_READERS, SCARD_DEFAULT_READERS, SCARD_LOCAL_READERS, SCARD_SYSTEM_READERS, SCardRemoveReaderFromGroup, SCardRemoveReaderFromGroup function [Security], SCardRemoveReaderFromGroupA, SCardRemoveReaderFromGroupW, _smart_scardremovereaderfromgroup, security.scardremovereaderfromgroup, winscard/SCardRemoveReaderFromGroup, winscard/SCardRemoveReaderFromGroupA, winscard/SCardRemoveReaderFromGroupW
winscard.h
Windows
Windows XP [desktop apps only]
Windows Server 2003 [desktop apps only]
SCardRemoveReaderFromGroupW (Unicode) and SCardRemoveReaderFromGroupA (ANSI)
Winscard.lib
Winscard.dll
Windows
19H1
SCardRemoveReaderFromGroupW
winscard/SCardRemoveReaderFromGroupW
c++
APIRef
kbSyntax
DllExport
Winscard.dll
SCardRemoveReaderFromGroup
SCardRemoveReaderFromGroupA
SCardRemoveReaderFromGroupW

SCardRemoveReaderFromGroupW function

-description

The SCardRemoveReaderFromGroup function removes a reader from an existing reader group. This function has no effect on the reader.

-parameters

-param hContext [in]

Handle that identifies the resource manager context. The resource manager context is set by a previous call to SCardEstablishContext. This parameter cannot be NULL.

-param szReaderName [in]

Display name of the reader to be removed.

-param szGroupName [in]

Display name of the group from which the reader should be removed.

Value Meaning
SCARD_ALL_READERS
TEXT("SCard$AllReaders\000")
Group used when no group name is provided when listing readers. Returns a list of all readers, regardless of what group or groups the readers are in.
SCARD_DEFAULT_READERS
TEXT("SCard$DefaultReaders\000")
Default group to which all readers are added when introduced into the system.
SCARD_LOCAL_READERS
TEXT("SCard$LocalReaders\000")
Unused legacy value. This is an internally managed group that cannot be modified by using any reader group APIs. It is intended to be used for enumeration only.
SCARD_SYSTEM_READERS
TEXT("SCard$SystemReaders\000")
Unused legacy value. This is an internally managed group that cannot be modified by using any reader group APIs. It is intended to be used for enumeration only.

-returns

This function returns different values depending on whether it succeeds or fails.

Return code Description
Success
SCARD_S_SUCCESS.
Failure
An error code. For more information, see Smart Card Return Values.

-remarks

When the last reader is removed from a group, the group is automatically forgotten.

The SCardRemoveReaderFromGroup function is a database management function. For information about other database management functions, see Smart Card Database Management Functions.

To add a reader to a reader group, use SCardAddReaderToGroup.

Examples

The following example shows how to remove a reader from the group.

// Remove a reader from the group.
// lReturn is of type LONG.
// hContext was set by a previous call to SCardEstablishContext.
// The group is automatically forgotten if no readers remain in it.
lReturn = SCardRemoveReaderFromGroup(hContext, 
                                     L"MyReader",
                                     L"MyReaderGroup");
if ( SCARD_S_SUCCESS != lReturn )
    printf("Failed SCardRemoveReaderFromGroup\n");

Note

The winscard.h header defines SCardRemoveReaderFromGroup 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.

-see-also

SCardAddReaderToGroup

SCardEstablishContext

SCardForgetCardType

SCardForgetReader

SCardForgetReaderGroup