Función GetUdpTable (iphlpapi.h)

Artículo
08/24/2023

La función GetUdpTable recupera la tabla del agente de escucha del Protocolo de datagramas de usuario (UDP) IPv4.

Sintaxis

IPHLPAPI_DLL_LINKAGE ULONG GetUdpTable(
  [out]     PMIB_UDPTABLE UdpTable,
  [in, out] PULONG        SizePointer,
  [in]      BOOL          Order
);

Parámetros

[out] UdpTable

Puntero a un búfer que recibe la tabla del agente de escucha UDP IPv4 como una estructura de MIB_UDPTABLE .

[in, out] SizePointer

En la entrada, especifica el tamaño en bytes del búfer al que apunta el parámetro UdpTable .

En la salida, si el búfer no es lo suficientemente grande como para contener la tabla de escucha devuelta, la función establece este parámetro igual al tamaño de búfer necesario en bytes.

En Windows SDK publicado para Windows Vista y versiones posteriores, el tipo de datos de este parámetro se cambia a un PULONG que es equivalente a un PDWORD.

[in] Order

Valor booleano que especifica si se debe ordenar la tabla de escucha UDP devuelta. Si este parámetro es TRUE, la tabla se ordena en el orden de:

Dirección IP local
Puerto local

Valor devuelto

Si la función se realiza correctamente, el valor devuelto es NO_ERROR.

Si se produce un error en la función, el valor devuelto es uno de los siguientes códigos de error.

Código devuelto	Descripción
ERROR_INSUFFICIENT_BUFFER	El búfer al que apunta el parámetro pUdpTable no es lo suficientemente grande. El tamaño necesario se devuelve en la variable ULONG a la que apunta el parámetro pdwSize . Este error también se devuelve si el parámetro pUdpTable es NULL.
ERROR_INVALID_PARAMETER	El parámetro pdwSize es NULL o GetUdpTable no puede escribir en la memoria a la que apunta el parámetro pdwSize .
ERROR_NOT_SUPPORTED	Esta función no se admite en el sistema operativo en uso en el sistema local.
Otros	Use FormatMessage para obtener la cadena de mensaje del error devuelto.

Comentarios

En Windows SDK publicado para Windows Vista y versiones posteriores, el valor devuelto de la función GetUdpTable se cambia a un tipo de datos de ULONG que es equivalente a un DWORD.

Requisitos


Cliente mínimo compatible	Windows 2000 Professional [aplicaciones de escritorio \| Aplicaciones para UWP]
Servidor mínimo compatible	Windows 2000 Server [aplicaciones de escritorio \| Aplicaciones para UWP]
Plataforma de destino	Windows
Encabezado	iphlpapi.h
Library	Iphlpapi.lib
Archivo DLL	Iphlpapi.dll