Función DhcpEnumSubnetElements (dhcpsapi.h)

La función DhcpEnumSubnetElements devuelve una lista enumerada de elementos para una subred DHCP específica.

Sintaxis

DWORD DHCP_API_FUNCTION DhcpEnumSubnetElements(
  [in]      DHCP_CONST WCHAR                 *ServerIpAddress,
  [in]      DHCP_IP_ADDRESS                  SubnetAddress,
  [in]      DHCP_SUBNET_ELEMENT_TYPE         EnumElementType,
  [in, out] DHCP_RESUME_HANDLE               *ResumeHandle,
  [in]      DWORD                            PreferredMaximum,
  [out]     LPDHCP_SUBNET_ELEMENT_INFO_ARRAY *EnumElementInfo,
  [out]     DWORD                            *ElementsRead,
  [out]     DWORD                            *ElementsTotal
);

Parámetros

[in] ServerIpAddress

Cadena Unicode que especifica la dirección IPv4 del servidor DHCP.

[in] SubnetAddress

DHCP_IP_ADDRESS valor que especifica la dirección de la subred IPv4 cuyos elementos se enumerarán.

[in] EnumElementType

DHCP_SUBNET_ELEMENT_TYPE valor de enumeración que indica el tipo de elemento de subred que se va a enumerar.

[in, out] ResumeHandle

Puntero a un valor de DHCP_RESUME_HANDLE que identifica la operación de enumeración. Inicialmente, este valor debe ser cero, con una llamada correcta que devuelve el valor de identificador usado para las solicitudes de enumeración posteriores. Por ejemplo, si PreferredMaximum se establece en 1000 bytes y se almacenan 2000 bytes de elementos de subred en el servidor, el identificador de reanudación se puede usar después de que se recuperen los primeros 1000 bytes para obtener los 1000 siguientes en una llamada posterior, etc.

La presencia de datos enumerables adicionales se indica cuando esta función devuelve ERROR_MORE_DATA. Si no hay datos enumerables adicionales disponibles en el servidor DHCPv4, se devuelve ERROR_NO_MORE_ITEMS.

[in] PreferredMaximum

Especifica el número máximo preferido de bytes de elementos de subred que se van a devolver. Si el número de opciones no enumeradas restantes (en bytes) es menor que este valor, se devolverá esa cantidad.

Para recuperar todos los elementos de cliente de subred para el usuario predeterminado y la clase de proveedor en el nivel especificado, establezca este parámetro en 0xFFFFFFFF.

[out] EnumElementInfo

Puntero a un puntero a una estructura de DHCP_SUBNET_ELEMENT_INFO_ARRAY que contiene una lista enumerada de todos los elementos disponibles para la subred especificada. Si no hay elementos disponibles para la enumeración, este valor será NULL.

[out] ElementsRead

Puntero a un valor DWORD que especifica el número de elementos de subred devueltos en EnumElementInfo.

[out] ElementsTotal

Puntero a un valor DWORD que especifica el número total de elementos sin enumerar que quedan en el servidor para la subred especificada.

Valor devuelto

Esta función devuelve ERROR_SUCCESS una llamada correcta. De lo contrario, devuelve uno de los códigos de error de la API de administración del servidor DHCP.

Código devuelto	Descripción
ERROR_DHCP_JET_ERROR	Error al acceder a la base de datos del servidor DHCP.
ERROR_MORE_DATA	Hay más elementos disponibles para enumerar.
ERROR_NO_MORE_ITEMS	No queda más elementos para enumerar.
ERROR_DHCP_SUBNET_NOT_PRESENT	La subred IPv4 especificada no existe en el servidor DHCP.

Requisitos

Cliente mínimo compatible	No se admite ninguno
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	dhcpsapi.h
Library	Dhcpsapi.lib
Archivo DLL	Dhcpsapi.dll

Consulte también

DHCP_SUBNET_ELEMENT_INFO_ARRAY

DHCP_SUBNET_ELEMENT_TYPE

DhcpEnumSubnetElementsV4

DhcpEnumSubnetElementsV5