3.2.4.92 R_DhcpV4FailoverDeleteRelationship (Opnum 91)

The R_DhcpV4FailoverDeleteRelationship method is used to delete an existing failover relationship on the DHCPv4 server.

 DWORD R_DhcpV4FailoverDeleteRelationship(
   [in, unique, string] DHCP_SRV_HANDLE ServerIpAddress,
   [in, string, unique] LPWSTR pRelationshipName
 );

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

pRelationshipName: A pointer to a null-terminated Unicode string that contains the name of the failover relationship to be deleted.

Return Values: A 32-bit unsigned integer value that indicates return status. The return value ERROR_SUCCESS (0x00000000) indicates that the operation was completed successfully. Otherwise, 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 20123, or any generic failure.

Return value/code

Description

0x00000000

ERROR_SUCCESS

The call was successful.

0x00004E92

ERROR_DHCP_FO_RELATIONSHIP_DOES_NOT_EXIST

The failover relationship doesn't exist.

The opnum field value for this method is 91.

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

  • If pRelationshipName parameter is NULL, return ERROR_INVALID_PARAMETER.

  • Validate whether this method is authorized for read/write access as specified in section 3.5.5. If not, return ERROR_ACCESS_DENIED.

  • Iterate through the elements in DHCPv4FailoverRelationshipList ADM element and retrieve the DHCPv4FailoverRelationship ADM element corresponding to the pRelationshipName parameter. If the corresponding DHCPv4FailoverRelationship ADM element is not found, return ERROR_DHCP_FO_RELATIONSHIP_DOES_NOT_EXIST.

  • For each of the IPv4 subnet address configured as part of retrieved DHCPv4FailoverRelationship ADM element, retrieve the corresponding DHCPv4Scope ADM element and set DHCPv4Scope.IsFailover to FALSE.

  • Delete the retrieved DHCPv4FailoverRelationship ADM element.

  • Return ERROR_SUCCESS.

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