Share via

3.2.4.47 R_DhcpGetServerSpecificStrings (Opnum 46)

  • Article

The R_DhcpGetServerSpecificStrings method retrieves the names of the default vendor class and user class. The caller of this function can free the memory pointed to by ServerSpecificStrings, DefaultVendorClassName and DefaultUserClassName by calling the function midl_user_free (section 3).

 DWORD R_DhcpGetServerSpecificStrings(
   [in, unique, string] DHCP_SRV_HANDLE ServerIpAddress,
   [out] LPDHCP_SERVER_SPECIFIC_STRINGS* ServerSpecificStrings
 );

ServerIpAddress: The IP address/host name of the DHCP server. This parameter is unused.

ServerSpecificStrings: This is a pointer of type LPDHCP_SERVER_SPECIFIC_STRINGS (section 2.2.1.2.77) that points to a location that contains information regarding the default vendor class and user class.

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.

0x00004E2D

ERROR_DHCP_JET_ERROR

An error occurred while accessing the DHCP server database.

The opnum field value for this method is 46.

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.

  • Allocate the memory for the information in the server ADM element DHCPServerSpecificStrings.

  • Retrieve the information in DHCPServerSpecificStrings object, copy them to respective fields in ServerSpecificStrings, and return them to the caller.

Exceptions Thrown: No exceptions are thrown beyond those thrown by the underlying RPC protocol [MS-RPCE].