Función DhcpV4GetOptionValue (dhcpsapi.h)

La función DhcpV4GetOptionValue recupera un valor de opción DHCP (el código de opción y los datos asociados) para un ámbito determinado. Esta función amplía la funcionalidad proporcionada por DhcpGetOptionValueV5 al permitir que el autor de la llamada especifique una directiva para la opción .

Sintaxis

DWORD DHCP_API_FUNCTION DhcpV4GetOptionValue(
  [in, optional] LPWSTR                   ServerIpAddress,
  [in]           DWORD                    Flags,
  [in]           DHCP_OPTION_ID           OptionID,
  [in, optional] LPWSTR                   PolicyName,
  [in, optional] LPWSTR                   VendorName,
  [in]           LPDHCP_OPTION_SCOPE_INFO ScopeInfo,
  [out]          LPDHCP_OPTION_VALUE      *OptionValue
);

Parámetros

[in, optional] ServerIpAddress

Puntero a una cadena Unicode terminada en null que representa la dirección IP o el nombre de host del servidor DHCP.

[in] Flags

Indica si la opción es para un proveedor específico o predeterminado.

Marcas	Significado
0x00000000	El valor de opción se recupera para un proveedor predeterminado.
DHCP_FLAGS_OPTION_IS_VENDOR 0x00000003	El valor de opción se recupera para un proveedor específico. El proveedor está en VendorName.

[in] OptionID

DHCP_OPTION_ID estructura que especifica el código de opción único para el valor de opción que se va a recuperar. Puede encontrar una lista completa de códigos de opción DHCP y BOOTP estándar en . http://www.ietf.org/rfc/rfc2132.txt

[in, optional] PolicyName

Cadena Unicode terminada en null que representa el nombre de la directiva dentro de la subred del valor de opción que se va a recuperar. La subred se identifica mediante el miembro SubnetScopeInfo de ScopeInfo.

[in, optional] VendorName

Cadena Unicode terminada en null que representa al proveedor de la opción. Este parámetro es opcional y debe ser NULL cuando Flags no es DHCP_FLAGS_OPTION_IS_VENDOR. Si no se especifica el proveedor, se devuelve el valor de opción para el proveedor predeterminado.

[in] ScopeInfo

DHCP_OPTION_SCOPE_INFO estructura que contiene información sobre el ámbito del valor de opción que se va a recuperar.

[out] OptionValue

Puntero a una estructura de DHCP_OPTION_DATA que contiene el valor de datos correspondiente al código de opción DHCP especificado por OptionID.

Valor devuelto

Si la función se realiza correctamente, devuelve ERROR_SUCCESS.

Si se produce un error en la función, devuelve uno de los siguientes códigos de error o un código de error de los códigos de error de la API de administración del servidor DHCP.

Valor	Significado
ERROR_INVALID_PARAMETER	Uno o varios de los parámetros no eran válidos.
ERROR_DHCP_SUBNET_NOT_PRESENT	La subred IPv4 especificada no existe.
ERROR_DHCP_CLASS_NOT_FOUND	El nombre de clase que se usa es desconocido o incorrecto.
ERROR_DHCP_POLICY_NOT_FOUND	El nombre de directiva especificado no existe.
ERROR_DHCP_OPTION_NOT_PRESENT	La definición de opción especificada no existe en la base de datos del servidor DHCP.

Comentarios

OptionValue debe ser gratuito mediante DhcpRpcFreeMemory.

Requisitos

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

Consulte también

DhcpV4GetAllOptionValues

DhcpV4RemoveOptionValue

DhcpV4SetOptionValue

DhcpV4SetOptionValues