Función DhcpSetOptionValue (dhcpsapi.h)

La función DhcpSetOptionValue establece información para un valor de opción específico en el servidor DHCP.

Sintaxis

DWORD DHCP_API_FUNCTION DhcpSetOptionValue(
  [in] DHCP_CONST WCHAR                  *ServerIpAddress,
  [in] DHCP_OPTION_ID                    OptionID,
  [in] DHCP_CONST DHCP_OPTION_SCOPE_INFO *ScopeInfo,
  [in] DHCP_CONST DHCP_OPTION_DATA       *OptionValue
);

Parámetros

[in] ServerIpAddress

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

[in] OptionID

DHCP_OPTION_ID valor que especifica el código único para una opción DHCP.

[in] ScopeInfo

Puntero a una estructura de DHCP_OPTION_SCOPE_INFO que contiene información que describe el nivel (predeterminado, servidor, ámbito o reserva IPv4) en el que se establecerá este valor de opción.

[in] OptionValue

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

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_DHCP_OPTION_NOT_PRESENT	No se encontró la definición de opción especificada en la base de datos del servidor DHCP.
ERROR_DHCP_SUBNET_NOT_PRESENT	La subred IPv4 especificada no existe en el servidor DHCP.
ERROR_DHCP_NOT_RESERVED_CLIENT	El cliente DHCP especificado no es un cliente reservado.
ERROR_FILE_NOT_FOUND	No se encontró el ámbito de multidifusión especificado en ScopeInfo en el servidor DHCP.

Comentarios

Cuando se llama a esta función por primera vez, crea el valor de opción proporcionado en la base de datos del servidor DHCP. De lo contrario, modifica el valor de opción de una opción específica asociada a la clase de usuario predeterminada y a la clase de proveedor. Estos valores se pueden establecer para el nivel de reserva predeterminado, servidor, ámbito o IPv4 en el servidor DHCP.

Requisitos

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

Consulte también

DHCP_OPTION_DATA

DHCP_OPTION_SCOPE_INFO

DhcpSetOptionValueV5

DhcpSetOptionValues