The R_DhcpGetAllOptionsV6 method retrieves all default option definitions, as well as specific user class and vendor class option definitions. The caller of this function can free the memory pointed to by OptionStruct, NonVendorOptions and VendorOptions and by calling the function midl_user_free (section 3).
DWORD R_DhcpGetAllOptionsV6( [in, unique, string] DHCP_SRV_HANDLE ServerIpAddress, [in] DWORD Flags, [out] LPDHCP_ALL_OPTIONS* OptionStruct );
ServerIpAddress: The IP address/host name of the DHCP server. This parameter is unused.
Flags: This field MUST be set to zero.
OptionStruct: This is a pointer of type LPDHCP_ALL_OPTIONS that points to the location that contains all vendor-specific option definitions as well as default option definitions.
Return Values: A 32-bit unsigned integer value that indicates return status. A return value ERROR_SUCCESS (0x00000000) indicates that the operation was completed successfully, else it contains a Win32 error code, as specified in [MS-ERREF]. This error code value can correspond to a DHCP-specific failure, which takes a value between 20000 and 20099, or any generic failure.
|
Return value/code |
Description |
|---|---|
|
0x00000000 ERROR_SUCCESS |
The call was successful. |
The opnum field value for this method is 55.
When processing this call, the DHCP server MUST do the following:
Validate if this method is authorized for read access per section 3.5.4. If not, return the error ERROR_ACCESS_DENIED.
Validate if the Flags field is not 0, then return ERROR_INVALID_PARAMETER.
Retrieve the DHCPv6ClassedOptionDef object from DHCPv6ClassedOptionDefList for the default vendor class, allocate the memory for the number of DHCPv6OptionDef objects in DHCPv6ClassedOptionDef.DHCPv6OptionDefList, and copy the information in the DHCPv6OptionDef objects to the allocated memory.
Retrieve the number of DHCPv6OptionDef objects from DHCPv6ClassedOptionDef.DHCPv6OptionDefList corresponding to all the non-default vendor classes, and allocate memory for them.
The DHCPv6OptionDef objects are retrieved and copied in the memory allocated for vendor-specific option.
The information in the DHCPv6OptionDef objects for default vendor class and in those for vendor specific option definitions is returned to the caller.
Exceptions Thrown: No exceptions are thrown beyond those thrown by the underlying RPC protocol [MS-RPCE].