Fonction DhcpV4FailoverGetRelationship (dhcpsapi.h)

  • Article

La fonction DhcpV4FailoverGetRelationship récupère les détails de la relation pour un nom de relation spécifique.

Syntaxe

DWORD DHCP_API_FUNCTION DhcpV4FailoverGetRelationship(
  [in, optional] LPWSTR                       ServerIpAddress,
  [in]           LPWSTR                       pRelationshipName,
  [out]          LPDHCP_FAILOVER_RELATIONSHIP *pRelationship
);

Paramètres

[in, optional] ServerIpAddress

Pointeur vers une chaîne Unicode terminée par null qui représente l’adresse IP ou le nom d’hôte du serveur DHCP.

[in] pRelationshipName

Pointeur vers une chaîne Unicode terminée par un caractère Null qui représente le nom de la relation à récupérer.

[out] pRelationship

Pointeur vers une structure DHCP_FAILOVER_RELATIONSHIP qui contient des informations sur la relation de basculement récupérée.

Remarque  

La mémoire de ce paramètre doit être libre à l’aide de DhcpRpcFreeMemory.

 

Valeur retournée

Si la fonction réussit, elle retourne ERROR_SUCCESS.

Si la fonction échoue, elle retourne l’un des codes d’erreur suivants ou un code d’erreur à partir des codes d’erreur de l’API gestion du serveur DHCP.

Valeur Signification
ERROR_INVALID_PARAMETER
 Un ou plusieurs des paramètres n’étaient pas valides.
ERROR_DHCP_FO_RELATIONSHIP_DOES_NOT_EXIST
 La relation de basculement n’existe pas.

Spécifications

   
Client minimal pris en charge Aucun pris en charge
Serveur minimal pris en charge Windows Server 2012 [applications de bureau uniquement]
Plateforme cible Windows
En-tête dhcpsapi.h
Bibliothèque Dhcpsapi.lib
DLL Dhcpsapi.dll

Voir aussi

DhcpV4FailoverCreateRelationship

DhcpV4FailoverDeleteRelationship

DhcpV4FailoverEnumRelationship

DhcpV4FailoverSetRelationship