DhcpGetOptionValueV5 function (dhcpsapi.h)

The DhcpGetOptionValueV5 function retrieves a DHCP option value (the option code and associated data) for a particular scope. This function extends the functionality provided by DhcpGetOptionValue by allowing the caller to specify a class and/or vendor for the option.

Syntax

DWORD DhcpGetOptionValueV5(
  [in]  LPWSTR                   ServerIpAddress,
  [in]  DWORD                    Flags,
  [in]  DHCP_OPTION_ID           OptionID,
  [in]  LPWSTR                   ClassName,
  [in]  LPWSTR                   VendorName,
  [in]  LPDHCP_OPTION_SCOPE_INFO ScopeInfo,
  [out] LPDHCP_OPTION_VALUE      *OptionValue
);

Parameters

[in] ServerIpAddress

Unicode string that specifies the IP address or hostname of the DHCP server.

[in] Flags

Flag value that indicates whether the option is for a specific or default vendor class.

[in] OptionID

DHCP_OPTION_ID value that specifies the code for the option value to retrieve.

[in] ClassName

Unicode string that specifies the DHCP class name of the option. This parameter is optional.

[in] VendorName

Unicode string that specifies the vendor of the option. This parameter is optional, and should be null when Flags is not set to DHCP_FLAGS_OPTION_IS_VENDOR. If the vendor class is not specified, the option value is returned for the default vendor class.

[in] ScopeInfo

DHCP_OPTION_SCOPE_INFO structure that contains information on the scope where the option value is set.

[out] OptionValue

DHCP_OPTION_VALUE structure that contains the returned option code and data.

Return value

This function returns ERROR_SUCCESS upon a successful call. Otherwise, it returns one of the DHCP Server Management API Error Codes.

Requirements

See also

DHCP_OPTION_SCOPE_INFO

DHCP_OPTION_VALUE

DhcpGetOptionValue

DhcpSetOptionValueV5