WsCloseListener, fonction (webservices.h)

Article
03/06/2024

Provoque l’arrêt de l’écoute de l’écouteur spécifié.

Syntaxe

HRESULT WsCloseListener(
  [in]           WS_LISTENER            *listener,
  [in, optional] const WS_ASYNC_CONTEXT *asyncContext,
  [in, optional] WS_ERROR               *error
);

Paramètres

[in] listener

Pointeur vers une structure WS_LISTENER représentant l’écouteur à fermer.

[in, optional] asyncContext

Pointeur vers une structure WS_ASYNC_CONTEXT contenant des informations permettant d’appeler la fonction de manière asynchrone. Passez la valeur NULL pour appeler la fonction de manière synchrone.

[in, optional] error

Pointeur vers une structure de WS_ERROR qui reçoit des informations d’erreur supplémentaires en cas d’échec de la fonction.

Valeur retournée

Si la fonction réussit, elle retourne NO_ERROR ; sinon, elle retourne un code d’erreur HRESULT.

Code de retour	Description
WS_S_ASYNC	L’opération asynchrone est toujours en attente.
WS_E_OPERATION_ABORTED	La fermeture a été abandonnée par un appel à WsAbortListener alors que l’écouteur se fermait.
WS_E_INVALID_OPERATION	L’écouteur était dans un état inapproprié.
WS_E_OPERATION_TIMED_OUT	L’opération ne s’est pas terminée dans le délai imparti.
E_INVALIDARG	Un ou plusieurs arguments ne sont pas valides.
Autres erreurs	Cette fonction peut retourner d’autres erreurs non répertoriées ci-dessus.

Remarques

Une fois l’écouteur fermé, l’écouteur peut être libéré en toute sécurité.

Cette opération est autorisée pour l’écouteur à l’état WS_LISTENER_STATE_OPEN ou WS_LISTENER_STATE_FAULTED . (Pour les états de l’écouteur, consultez l’énumération WS_LISTENER_STATE .)

Lorsqu’un écouteur est fermé, toutes les tentatives en attente d’acceptation d’un canal avec la méthode WsAcceptChannel sont abandonnées. Toutefois, WsCloseListener attend que toutes les E/S en attente se terminent avant de poursuivre le processus de fermeture.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 7 [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2008 R2 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	webservices.h
Bibliothèque	WebServices.lib
DLL	WebServices.dll

Partager via