Función WSAAsyncGetProtoByNumber (winsock.h)

  • Artículo

La función WSAAsyncGetProtoByNumber recupera asincrónicamente la información del protocolo que corresponde a un número de protocolo.

Sintaxis

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

Parámetros

[in] hWnd

Identificador de la ventana que recibirá un mensaje cuando se complete la solicitud asincrónica.

[in] wMsg

Mensaje que se va a recibir cuando se completa la solicitud asincrónica.

[in] number

Número de protocolo que se va a resolver, en orden de bytes de host.

[out] buf

Puntero al área de datos para recibir los datos protoent . El área de datos debe ser mayor que el tamaño de una estructura protoent porque Windows Sockets usa el área de datos para contener una estructura protoent y todos los datos a los que hacen referencia los miembros de la estructura protoent . Se recomienda un búfer de bytes MAXGETHOSTSTRUCT.

[in] buflen

Tamaño del área de datos para el parámetro buf , en bytes.

Valor devuelto

El valor devuelto especifica si la operación asincrónica se inició correctamente o no. No implica éxito o fracaso de la propia operación.

Si no se produce ningún error, WSAAsyncGetProtoByNumber devuelve un valor distinto de cero del tipo HANDLE que es el identificador de tarea asincrónico para la solicitud (no debe confundirse con un HTASK de Windows). Este valor se puede usar de dos maneras. Se puede usar para cancelar la operación mediante WSACancelAsyncRequest, o se puede usar para buscar coincidencias con las operaciones asincrónicas y los mensajes de finalización mediante el examen del parámetro de mensaje wParam .

Si no se pudo iniciar la operación asincrónica, WSAAsyncGetProtoByNumber devuelve un valor cero y se puede recuperar un número de error específico llamando a WSAGetLastError.

Los siguientes códigos de error se pueden establecer cuando una ventana de la aplicación recibe un mensaje. Como se ha descrito anteriormente, se pueden extraer de lParam en el mensaje de respuesta mediante la macro WSAGETASYNCERROR .

Código de error Significado
WSAENETDOWN
 Error en el subsistema de red.
WSAENOBUFS
 No hay suficiente espacio en búfer disponible.
WSAEFAULT
 El parámetro buf no está en una parte válida del espacio de direcciones del proceso.
WSAHOST_NOT_FOUND
 No se encontró el protocolo de respuesta autoritativa.
WSATRY_AGAIN
 No se encontró el protocolo no autenticado o error del servidor.
WSANO_RECOVERY
 Errores irrecuperables, la base de datos de protocolos no es accesible.
WSANO_DATA
 Nombre válido, sin registro de datos del tipo solicitado.
 

Los errores siguientes pueden producirse en el momento de la llamada a la función e indicar que no se pudo iniciar la operación asincrónica.

Código de error Significado
WSANOTINITIALISED Debe producirse una llamada WSAStartup correcta antes de usar esta función.
WSAENETDOWN Error en el subsistema de red.
WSAEINPROGRESS Una llamada de Bloqueo de Windows Sockets 1.1 está en curso o el proveedor de servicios sigue procesando una función de devolución de llamada.
WSAEWOULDBLOCK La operación asincrónica no se puede programar en este momento debido a recursos u otras restricciones dentro de la implementación de Windows Sockets.

Comentarios

La función WSAAsyncGetProtoByNumber es una versión asincrónica de getprotobynumber y se usa para recuperar el nombre del protocolo y el número correspondientes a un número de protocolo. Windows Sockets inicia la operación y vuelve al autor de la llamada inmediatamente, pasando un identificador de tarea opaco y asincrónico que la aplicación puede usar para identificar la operación. Cuando se completa la operación, los resultados (si existen) se copian en el búfer proporcionado por el autor de la llamada y se envía un mensaje a la ventana de la aplicación.

Una vez completada la operación asincrónica, la ventana de la aplicación indicada por el parámetro hWnd recibe el mensaje en el parámetro wMsg . El parámetro wParam contiene el identificador de tarea asincrónico tal como lo devuelve la llamada de función original. Los 16 bits altos de lParam contienen cualquier código de error. El código de error puede ser cualquier error tal y como se define en Winsock2.h. Un código de error de cero indica que la operación asincrónica se completó correctamente.

Cuando se completa correctamente, el búfer especificado en la llamada de función original contiene una estructura protoent . Para acceder a los miembros de esta estructura, la dirección del búfer original se convierte en un puntero de estructura protoent y se obtiene acceso a él según corresponda.

Si el código de error es WSAENOBUFS, el tamaño del búfer especificado por buflen en la llamada original era demasiado pequeño para contener toda la información resultante. En este caso, los 16 bits bajos de lParam contienen el tamaño del búfer necesario para proporcionar toda la información necesaria. Si la aplicación decide que los datos parciales son inadecuados, puede volver a emitir la llamada de función WSAAsyncGetProtoByNumber con un búfer lo suficientemente grande como para recibir toda la información deseada (es decir, no menor que los 16 bits bajos de lParam).

Windows Sockets usa el búfer especificado para esta función para construir una estructura protoent junto con el contenido de las áreas de datos a las que hacen referencia los miembros de la misma estructura protoent . Para evitar el error WSAENOBUFS indicado anteriormente, la aplicación debe proporcionar un búfer de al menos MAXGETHOSTSTRUCT bytes (como se define en Winsock2.h).

El código de error y la longitud del búfer deben extraerse de lParam mediante las macros WSAGETASYNCERROR y WSAGETASYNCBUFLEN, definidas en Winsock2.h como:

#include <windows.h>

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

El uso de estas macros maximizará la portabilidad del código fuente de la aplicación.

Requisitos

   
Cliente mínimo compatible Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado winsock.h (incluya Winsock2.h)
Library Ws2_32.lib
Archivo DLL Ws2_32.dll

Consulte también

WSACancelAsyncRequest

Funciones winsock

Referencia de Winsock

getprotobynumber