The R_DhcpCreateOptionV5 method creates an option definition of a specific option for a specific user class and vendor class at the default option level. The OptionId specifies the identifier of the option. If the user class or vendor class is not defined, the option definition is created for the default user class and vendor class.

 DWORD R_DhcpCreateOptionV5(
   [in, unique, string] DHCP_SRV_HANDLE ServerIpAddress,
   [in] DWORD Flags,
   [in] DHCP_OPTION_ID OptionId,
   [in, string, unique] WCHAR* ClassName,
   [in, string, unique] WCHAR* VendorName,
   [in] LPDHCP_OPTION OptionInfo
 );

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

Flags: This is of type DWORD that specifies that the option definition is created for a specific or default vendor class.

Value	Meaning
DHCP_FLAGS_OPTION_DEFAULT 0x00000000	Option definition is created for the default vendor class.
DHCP_FLAGS_OPTION_IS_VENDOR 0x00000003	If a bitwise AND operation with this bitmask yields a nonzero value, it indicates that the option definition is created for a specific vendor class.

OptionId: This is of type DHCP_OPTION_ID (section 2.2.1.2.3), containing the option identifier for the option being created.

ClassName: A pointer to a null-terminated Unicode string that contains the name of the user class for which the option definition is created. This parameter is optional. If the ClassName parameter is not specified, the option definition is created for the default user class.

VendorName: A pointer to a null-terminated Unicode string that contains the name of the vendor class for which the option definition is created. This parameter is optional, and if the vendor class name is not specified, the option definition is created for the default vendor class.

OptionInfo: This is a pointer to a DHCP_OPTION (section 2.2.1.2.25) structure that contains the information about the option definition.

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.
0x00004E29 ERROR_DHCP_OPTION_EXITS	The specified option definition already exists on DHCP server database.
0x00004E2D ERROR_DHCP_JET_ERROR	An error occurred while accessing the DHCP server database.
0x00004E4C ERROR_DHCP_CLASS_NOT_FOUND	The class name being used is unknown or incorrect.

The opnum field value for this method is 14.

When processing this call, the DHCP server MUST do the following:

• Validate if this method is authorized for read/write access per section 3.5.5. If not, return ERROR_ACCESS_DENIED.

• The Flags parameter MUST pass one of the validations given in the Flags field description. Otherwise, the method returns ERROR_INVALID_PARAMETER.

• If ClassName is not NULL, retrieve the DHCPv4ClassDef entry corresponding to the ClassName from the server ADM element DHCPv4ClassDefList. If the DHCPv4ClassDef entry is not found, return ERROR_DHCP_CLASS_NOT_FOUND. If ClassName is NULL, it refers to the default user class (see section 3.1.1.9).

• If VendorName is not NULL, retrieve the DHCPv4ClassDef entry corresponding to the VendorName from the server ADM element DHCPv4ClassDefList. If the DHCPv4ClassDef entry is not found, return ERROR_DHCP_CLASS_NOT_FOUND. If VendorName is NULL, it refers to the default vendor class (see section 3.1.1.9).

• Validate the DefaultValue data structure, pointed to by the OptionInfo parameter, by checking that its Elements member is not NULL and that its NumElements member is not zero. If either check fails, return ERROR_INVALID_PARAMETER.

• Iterate through the server ADM element DHCPv4OptionDefList and retrieve the DHCPv4OptionDef.DHCPv4ClassedOptDefList corresponding to the user and vendor class specified by ClassName and VendorName respectively. If ClassName or VendorName is NULL, it refers to the default user class or vendor class respectively, as specified in section 3.1.1.9. If there is no DHCPv4OptionDef entry corresponding to specified user and vendor classes, return ERROR_DHCP_CLASS_NOT_FOUND.

• Iterate through DHCPv4ClassedOptDefList and if there is any DHCPv4ClassedOptDef entry corresponding to OptionId, return ERROR_DHCP_OPTION_EXITS.

• Create a DHCPv4ClassedOptDef object and insert it into DHCPv4ClassedOptDefList. The DHCPv4ClassedOptDef object is initialized with information in the OptionInfo input parameter.

• Return ERROR_SUCCESS.

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