Expand Minimize

SCardRemoveReaderFromGroup function

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

Syntax


LONG WINAPI SCardRemoveReaderFromGroup(
  _In_  SCARDCONTEXT hContext,
  _In_  LPCTSTR szReaderName,
  _In_  LPCTSTR szGroupName
);

Parameters

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.

szReaderName [in]

Display name of the reader to be removed.

szGroupName [in]

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

ValueMeaning
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.

 

Return value

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

Return codeDescription
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");


Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Winscard.h

Library

Winscard.lib

DLL

Winscard.dll

Unicode and ANSI names

SCardRemoveReaderFromGroupW (Unicode) and SCardRemoveReaderFromGroupA (ANSI)

See also

SCardEstablishContext
SCardAddReaderToGroup
SCardForgetCardType
SCardForgetReader
SCardForgetReaderGroup

 

 

Community Additions

ADD
Show:
© 2014 Microsoft