Fonction WPUQuerySocketHandleContext (ws2spi.h)

Article
03/13/2024

La fonction WPUQuerySocketHandleContext interroge la valeur de contexte associée au handle de socket spécifié.

Syntaxe

int WPUQuerySocketHandleContext(
  [in]  SOCKET     s,
  [out] PDWORD_PTR lpContext,
  [out] LPINT      lpErrno
);

Paramètres

[in] s

Description qui identifie le socket dont le contexte doit être interrogé.

[out] lpContext

Pointeur qui recevra la valeur de contexte.

[out] lpErrno

Pointeur vers le code d’erreur.

Valeur retournée

Si aucune erreur ne se produit, WPUQuerySocketHandleContext retourne zéro et stocke la valeur de contexte actuelle dans lpContext. Sinon, il retourne SOCKET_ERROR, et un code d’erreur spécifique est disponible dans lpErrno.

Code d'erreur	Signification
WSAENOTSOCK	Le descripteur n’est pas un socket créé par WPUCreateSocketHandle.

Remarques

La fonction WPUQuerySocketHandleContext interroge la valeur de contexte actuelle associée au handle de socket spécifié. Les fournisseurs de services utilisent généralement cette fonction pour récupérer un pointeur vers des données spécifiques au fournisseur associées au socket. Par exemple, un fournisseur de services peut utiliser le contexte de socket pour stocker un pointeur vers une structure contenant l’état du socket, les adresses de transport locales et distantes et les objets d’événement pour signaler les événements réseau.

Seuls les fournisseurs non IFS utilisent cette fonction, car les fournisseurs IFS ne sont pas en mesure de fournir une valeur de contexte.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	ws2spi.h

Voir aussi

WPUCreateSocketHandle

Partager via