Funzione WSAAsyncGetProtoByNumber (winsock.h)

La funzione WSAAsyncGetProtoByNumber recupera in modo asincrono le informazioni sul protocollo che corrispondono a un numero di protocollo.

Sintassi

HANDLE WSAAsyncGetProtoByNumber(
  [in]  HWND  hWnd,
  [in]  u_int wMsg,
  [in]  int   number,
  [out] char  *buf,
  [in]  int   buflen
);

Parametri

[in] hWnd

Handle della finestra che riceverà un messaggio al termine della richiesta asincrona.

[in] wMsg

Messaggio da ricevere al termine della richiesta asincrona.

[in] number

Numero di protocollo da risolvere, in ordine di byte host.

[out] buf

Puntatore all'area dati per ricevere i dati protoent . L'area dati deve essere maggiore della dimensione di una struttura protoent perché l'area dati viene usata da Windows Sockets per contenere una struttura protoent e tutti i dati a cui fanno riferimento i membri della struttura protoent . È consigliabile usare un buffer di byte MAXGETHOSTSTRUCT.

[in] buflen

Dimensioni dell'area dati per il parametro buf , in byte.

Valore restituito

Il valore restituito specifica se l'operazione asincrona è stata avviata correttamente. Non implica l'esito positivo o negativo dell'operazione stessa.

Se non si verifica alcun errore, WSAAsyncGetProtoByNumber restituisce un valore diverso da zero di tipo HANDLE che rappresenta l'handle di attività asincrona per la richiesta (da non confondere con un HTASK di Windows). Questo valore può essere usato in due modi. Può essere usato per annullare l'operazione usando WSACancelAsyncRequest oppure per trovare una corrispondenza con operazioni asincrone e messaggi di completamento, esaminando il parametro del messaggio wParam .

Se non è stato possibile avviare l'operazione asincrona, WSAAsyncGetProtoByNumber restituisce un valore zero e un numero di errore specifico può essere recuperato chiamando WSAGetLastError.

Quando una finestra dell'applicazione riceve un messaggio, è possibile impostare i codici di errore seguenti. Come descritto in precedenza, possono essere estratti dal parametro lParam nel messaggio di risposta usando la macro WSAGETASYNCERROR .

Al momento della chiamata di funzione possono verificarsi gli errori seguenti e indicare che non è stato possibile avviare l'operazione asincrona.

Commenti

La funzione WSAAsyncGetProtoByNumber è una versione asincrona di getprotobynumber e viene usata per recuperare il nome e il numero del protocollo corrispondenti a un numero di protocollo. Windows Sockets avvia l'operazione e torna immediatamente al chiamante, passando un handle di attività opaco e asincrono che l'applicazione può usare per identificare l'operazione. Al termine dell'operazione, i risultati (se presenti) vengono copiati nel buffer fornito dal chiamante e viene inviato un messaggio alla finestra dell'applicazione.

Al termine dell'operazione asincrona, la finestra dell'applicazione indicata dal parametro hWnd riceve il messaggio nel parametro wMsg . Il parametro wParam contiene l'handle di attività asincrono restituito dalla chiamata di funzione originale. Gli alti 16 bit di lParam contengono qualsiasi codice di errore. Il codice di errore può essere qualsiasi errore definito in Winsock2.h. Un codice di errore pari a zero indica il completamento dell'operazione asincrona.

Al completamento, il buffer specificato nella chiamata di funzione originale contiene una struttura protoent . Per accedere ai membri di questa struttura, viene eseguito il cast dell'indirizzo del buffer originale a un puntatore di struttura protoent e a cui si accede in base alle esigenze.

Se il codice di errore è WSAENOBUFS, la dimensione del buffer specificato da buflen nella chiamata originale era troppo piccola per contenere tutte le informazioni risultanti. In questo caso, i 16 bit bassi di lParam contengono le dimensioni del buffer necessarie per fornire tutte le informazioni necessarie. Se l'applicazione decide che i dati parziali non sono adeguati, può eseguire nuovamente la chiamata alla funzione WSAAsyncGetProtoByNumber con un buffer di dimensioni sufficienti per ricevere tutte le informazioni desiderate, ovvero non inferiori ai 16 bit bassi di lParam.

Il buffer specificato per questa funzione viene usato da Windows Sockets per costruire una struttura protoent insieme al contenuto delle aree dati a cui fanno riferimento i membri della stessa struttura protoent . Per evitare l'errore WSAENOBUFS indicato in precedenza, l'applicazione deve fornire un buffer di almeno MAXGETHOSTSTRUCT byte (come definito in Winsock2.h).

Il codice di errore e la lunghezza del buffer devono essere estratti da lParam usando le macro WSAGETASYNCERROR e WSAGETASYNCBUFLEN, definite in Winsock2.h come:

#include <windows.h>

#define WSAGETASYNCBUFLEN(lParam)           LOWORD(lParam)
#define WSAGETASYNCERROR(lParam)            HIWORD(lParam)

L'uso di queste macro consente di ottimizzare la portabilità del codice sorgente per l'applicazione.

Requisiti

Vedi anche

WSACancelAsyncRequest

Funzioni Winsock

Informazioni di riferimento su Winsock

getprotobynumber