PFN_WSK_GET_LOCAL_ADDRESS fonction de rappel (wsk.h)

La fonction WskGetLocalAddress récupère l’adresse de transport locale d’un socket.

Syntaxe

PFN_WSK_GET_LOCAL_ADDRESS PfnWskGetLocalAddress;

NTSTATUS PfnWskGetLocalAddress(
  [in]      PWSK_SOCKET Socket,
  [out]     PSOCKADDR LocalAddress,
  [in, out] PIRP Irp
)
{...}

Paramètres

[in] Socket

Pointeur vers une structure WSK_SOCKET qui spécifie l’objet socket pour le socket qui est interrogé.

[out] LocalAddress

Pointeur vers une mémoire tampon allouée par l’appelant qui reçoit l’adresse de transport locale du socket. La mémoire tampon doit se trouver en mémoire non paginée. La mémoire tampon doit également être suffisamment grande pour contenir le type de structure SOCKADDR spécifique qui correspond à la famille d’adresses spécifiée par l’application WSK spécifiée lors de la création du socket.

Pour un socket orienté connexion que l’application WSK a accepté sur un socket d’écoute, la famille d’adresses est identique à la famille d’adresses que l’application WSK spécifiée lors de la création du socket d’écoute.

[in, out] Irp

Pointeur vers un IRP alloué par l’appelant que le sous-système WSK utilise pour terminer l’opération de récupération de façon asynchrone. Pour plus d’informations sur l’utilisation d’IRPs avec des fonctions WSK, consultez Utilisation d’IRPs avec des fonctions de noyau Winsock.

Valeur de retour

WskGetLocalAddress retourne l’un des codes NTSTATUS suivants :

Code de retour Description
STATUS_SUCCESS
L’adresse de transport locale du socket a été récupérée avec succès. L’IRP sera terminé avec l’état de réussite.
STATUS_PENDING
Le sous-système WSK n’a pas pu récupérer l’adresse de transport locale du socket immédiatement. Le sous-système WSK termine l’IRP une fois qu’il a récupéré l’adresse de transport locale du socket. L’état de l’opération de récupération est retourné dans le champ IoStatus.Status de l’IRP.
STATUS_INVALID_DEVICE_STATE
Le socket n’est pas lié à une adresse de transport locale. L’IRP est terminé avec l’état d’échec.
STATUS_FILE_FORCED_CLOSED
Le socket n’est plus fonctionnel. L’IRP est terminé avec l’état d’échec. L’application WSK doit appeler la fonction WskCloseSocket pour fermer le socket dès que possible.
Autres codes d’état
Une erreur est survenue. L’IRP est terminé avec l’état d’échec.

Remarques

Une application WSK peut appeler la fonction WskGetLocalAddress uniquement sur un socket lié à une adresse de transport locale.

Un socket d’écoute, de datagramme ou de flux est lié à une adresse de transport locale lorsque l’application WSK appelle la fonction WskBind .

Un socket orienté connexion est lié à une adresse de transport locale de l’une des façons suivantes :

  • L’application WSK appelle la fonction WskBind .
  • L’application WSK crée, lie et connecte le socket en appelant la fonction WskSocketConnect .
  • Le sous-système WSK lie le socket lorsque l’application WSK accepte une demande de connexion entrante sur un socket d’écoute.
La fonction WskGetLocalAddress est particulièrement utile pour déterminer l’adresse de transport locale spécifique affectée à un socket par le protocole de transport lorsque le socket a été lié à l’adresse générique locale. Pour un socket orienté connexion lié à l’adresse générique locale, l’adresse de transport locale peut ne pas être affectée au socket par le protocole de transport tant que le socket n’est pas connecté à une adresse de transport distante. Étape où l’adresse de transport locale est affectée au socket est dépendante du protocole de transport. Pour TCP, le numéro de port est attribué lorsqu’un socket orienté connexion est lié, mais l’adresse IP n’est pas affectée tant que le socket n’est pas connecté.

Si la fonction WskGetLocalAddress retourne STATUS_PENDING, la mémoire tampon pointée par le paramètre LocalAddress doit rester valide jusqu’à ce que le protocole IRP soit terminé. Si l’application WSK a alloué la mémoire tampon avec l’une des fonctions ExAllocateXxx , elle ne peut pas libérer la mémoire avec la fonction ExFreeXxx correspondante jusqu’à ce que l’IRP soit terminé. Si l’application WSK a alloué la mémoire tampon sur la pile, elle ne peut pas retourner à partir de la fonction qui appelle la fonction WskGetLocalAddress jusqu’à ce que l’IRP soit terminé.

Configuration requise

   
Client minimal pris en charge Disponible dans Windows Vista et versions ultérieures des systèmes d’exploitation Windows.
Plateforme cible Universal
En-tête wsk.h (inclure Wsk.h)
IRQL <= DISPATCH_LEVEL

Voir aussi

SOCKADDR

WSK_PROVIDER_CONNECTION_DISPATCH WSK_PROVIDER_DATAGRAM_DISPATCH

WSK_PROVIDER_LISTEN_DISPATCH

WSK_PROVIDER_STREAM_DISPATCH

WSK_SOCKET

WskAccept

WskAcceptEvent

WskBind

WskCloseSocket

WskConnect

WskGetRemoteAddress

WskSocketConnect