Windows Dev Center

Expand Minimize

DhcpV4FailoverEnumRelationship function

The DhcpV4FailoverEnumRelationship function enumerates all failover relationships present on the server.

Syntax


DWORD DHCP_API_FUNCTION DhcpV4FailoverEnumRelationship(
  _In_opt_ LPWSTR                             ServerIpAddress,
  _Inout_  DHCP_RESUME_HANDLE                 *ResumeHandle,
  _In_     DWORD                              preferredMaximum,
  _Out_    LPDHCP_FAILOVER_RELATIONSHIP_ARRAY *pRelationship,
  _Out_    LPDWORD                            relationshipRead,
  _Out_    LPDWORD                            relationshipTotal
);

Parameters

ServerIpAddress [in, optional]

Pointer to a null-terminated Unicode string that represents the IP address or hostname of the DHCP server.

ResumeHandle [in, out]

Pointer to a DHCP_RESUME_HANDLE structure that identifies this enumeration for use in subsequent calls to this function.

Initially, this value should be zero on input. If successful, the returned value should be used for subsequent enumeration requests. For example, if PreferredMaximum is set to 100, and 200 reservation elements are configured on the server, the resume handle can be used after the first 100 policies are retrieved to obtain the next 100 on a subsequent call.

preferredMaximum [in]

The maximum number of failover relationship elements to return in pRelationship. If PreferredMaximum is greater than the number of remaining non-enumerated policies on the server, the remaining number of non-enumerated policies is returned.

pRelationship [out]

Pointer to a DHCP_FAILOVER_RELATIONSHIP_ARRAY structure that contains an array of the failover relationships available on the DHCP server. If no relationships are configured, this value is NULL.

relationshipRead [out]

Pointer to a DWORD that specifies the number of failover relationship elements returned in pRelationship.

relationshipTotal [out]

Pointer to a DWORD that specifies the number of failover relationships configured on the DHCP server that have not yet been enumerated.

Return value

If the function succeeds, it returns ERROR_SUCCESS.

If the function fails, it returns one of the following. or an error code from DHCP Server Management API Error Codes

ValueMeaning
ERROR_INVALID_PARAMETER

One or more of the parameters were invalid.

ERROR_MORE_DATA

There are more elements available to enumerate.

ERROR_NO_MORE_ITEMS

There are no more elements left to enumerate.

 

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

Dhcpsapi.h

Library

Dhcpsapi.lib

DLL

Dhcpsapi.dll

See also

DhcpV4FailoverDeleteRelationship
DhcpV4FailoverCreateRelationship
DhcpV4FailoverGetRelationship
DhcpV4FailoverSetRelationship

 

 

Community Additions

ADD
Show:
© 2015 Microsoft