SCardForgetReaderGroupA, fonction (winscard.h)

Article
08/27/2023

La fonction SCardForgetReaderGroup supprime un groupe smart carte reader précédemment introduit du sous-système smart carte. Bien que cette fonction efface automatiquement tous les lecteurs du groupe, elle n’affecte pas l’existence des lecteurs individuels dans la base de données.

Syntaxe

LONG SCardForgetReaderGroupA(
  [in] SCARDCONTEXT hContext,
  [in] LPCSTR       szGroupName
);

Paramètres

[in] hContext

Handle qui identifie le contexte resource manager. Le contexte du gestionnaire de ressources est défini par un appel précédent à SCardEstablishContext. Ce paramètre ne peut pas être NULL.

[in] szGroupName

Nom d’affichage du groupe de lecteurs à supprimer. Les groupes de lecteurs définis par le système ne peuvent pas être supprimés de la base de données.

Valeur	Signification
SCARD_ALL_READERS TEXT(« SCard$AllReaders\000 »)	Groupe utilisé lorsqu’aucun nom de groupe n’est fourni lors de la liste des lecteurs. Retourne une liste de tous les lecteurs, quel que soit le groupe ou les groupes dans qui se trouvent les lecteurs.
SCARD_DEFAULT_READERS TEXT(« SCard$DefaultReaders\000 »)	Groupe par défaut auquel tous les lecteurs sont ajoutés lors de leur introduction dans le système.
SCARD_LOCAL_READERS TEXT(« SCard$LocalReaders\000 »)	Valeur héritée inutilisée. Il s’agit d’un groupe géré en interne qui ne peut pas être modifié à l’aide des API de groupe de lecteurs. Il est destiné à être utilisé pour l’énumération uniquement.
SCARD_SYSTEM_READERS TEXT(« SCard$SystemReaders\000 »)	Valeur héritée inutilisée. Il s’agit d’un groupe géré en interne qui ne peut pas être modifié à l’aide des API de groupe de lecteurs. Il est destiné à être utilisé pour l’énumération uniquement.

Valeur retournée

Cette fonction retourne des valeurs différentes selon qu’elle réussit ou échoue.

Code de retour	Description
Success	SCARD_S_SUCCESS.
Échec	Code d'erreur. Pour plus d’informations, consultez Valeurs de retour de carte à puce.

Remarques

La fonction SCardForgetReaderGroup est une fonction de gestion de base de données. Pour plus d’informations sur les autres fonctions de gestion de base de données, consultez Fonctions de gestion de base de données par carte à puce.

Exemples

L’exemple suivant montre comment supprimer un groupe de lecteurs du système. L’exemple suppose que lReturn est une variable existante de type LONG et que hContext est un handle valide pour un contexte resource manager précédemment obtenu à partir d’un appel à la fonction SCardEstablishContext .


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

Notes

L’en-tête winscard.h définit SCardForgetReaderGroup comme alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. La combinaison de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows XP [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2003 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	winscard.h
Bibliothèque	Winscard.lib
DLL	Winscard.dll