LPNSPV2CLEANUP fonction de rappel (ws2spi.h)

Article
08/28/2023

La fonction NSPv2Cleanup avertit un fournisseur de fournisseurs de services d’espace de noms version 2 (NSPv2) qu’une session cliente s’est terminée.

Syntaxe

LPNSPV2CLEANUP Lpnspv2cleanup;

INT Lpnspv2cleanup(
  [in] LPGUID lpProviderId,
  [in] LPVOID pvClientSessionArg
)
{...}

Paramètres

[in] lpProviderId

Pointeur vers le GUID du fournisseur d’espace de noms à notifier.

[in] pvClientSessionArg

Pointeur vers la session cliente.

Valeur retournée

La fonction doit retourner NO_ERROR (zéro) si la routine réussit. Elle doit retourner SOCKET_ERROR (autrement dit, 1) si la routine échoue et doit définir le code d’erreur approprié à l’aide de WSASetLastError.

Code d'erreur	Signification
WSA_NOT_ENOUGH_MEMORY	La mémoire disponible est insuffisante pour effectuer cette opération.
WSAEACCES	La routine appelante ne dispose pas des privilèges suffisants pour initialiser le service.
WSAEINVAL	Un ou plusieurs paramètres n’étaient pas valides ou manquants pour ce fournisseur.
WSAEOPNOTSUPP	L'opération n'est pas prise en charge. Cette erreur est retournée si le fournisseur d’espaces de noms n’implémente pas cette fonction.
WSASERVICE_NOT_FOUND	Le service est inconnu. Le service est introuvable dans l’espace de noms spécifié.

Remarques

La fonction NSPv2Cleanup est utilisée dans le cadre de l’architecture du fournisseur de services d’espace de noms version 2 (NSPv2) disponible sur Windows Vista et versions ultérieures.

Sur Windows Vista et Windows Server 2008, la fonction NSPv2Cleanup ne peut être utilisée que pour les opérations sur NS_EMAIL fournisseurs d’espaces de noms.

La fonction NSPv2Startup est appelée chaque fois qu’un nouveau processus client commence à utiliser le fournisseur d’espaces de noms. Les fournisseurs peuvent utiliser l’argument de session client vers lequel pointe le paramètre ppvClientSessionArg pour stocker des informations sur cette session. Si une valeur a été spécifiée pour l’argument de session cliente dans l’appel à la fonction NSPv2Startup , ce même argument de session client peut être passé dans le paramètre pvClientSessionArg à la fonction NSPv2Cleanup pour informer le fournisseur d’espace de noms que la session cliente s’est terminée.

La fonction NSPv2Cleanup est appelée lorsqu’une application a terminé d’utiliser un fournisseur de services d’espace de noms Windows Sockets. NSPv2Cleanup permet au fournisseur d’espaces de noms de libérer toutes les ressources du fournisseur d’espaces de noms qui ont été allouées pour la session cliente.

La fonction NSPv2Startup doit être appelée correctement avant d’appeler la fonction NSPv2Cleanup . Il est autorisé d’effectuer plusieurs appels NSPv2Startup . Toutefois, pour chaque appel NSPv2Startup , un appel NSPv2Cleanup correspondant doit également être émis. Seul le NSPv2Cleanup final pour le fournisseur de services effectue le nettoyage réel ; les appels précédents décrémentent un nombre de références internes dans le fournisseur de services.

Les fonctions NSPv2Startup, NSPv2ClientSessionRundown et NSPv2Cleanup sont facultatives, en fonction des exigences du fournisseur NSPv2.

Si la fonction NSPv2Cleanup n’est pas implémentée, les appels à cette fonction doivent être interceptés par une fonction stub qui retourne WSAEOPNOTSUPP. Le pointeur de la fonction NSPv2 vers la fonction NSPv2Cleanup non implémentée dans la structure NSPV2_ROUTINE doit pointer vers la fonction stub.

Spécifications


Client minimal pris en charge	Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2008 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	ws2spi.h