Fonction DhcpV4FailoverGetScopeRelationship (dhcpsapi.h)

  • Article

La fonction DhcpV4FailoverGetScopeRelationship récupère la relation de basculement configurée sur une étendue DHCPv4 spécifiée.

Syntaxe

DWORD DHCP_API_FUNCTION DhcpV4FailoverGetScopeRelationship(
  [in, optional] LPWSTR                       ServerIpAddress,
  [in]           DHCP_IP_ADDRESS              ScopeId,
  [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] ScopeId

Champ DHCP_IP_ADDRESS qui contient l’adresse d’étendue IPv4 pour laquelle les détails de la relation doivent être récupérés.

[out] pRelationship

Pointeur vers une structure de DHCP_FAILOVER_RELATIONSHIP qui contient des informations sur la relation de basculement récupérée qui contient le champ scopeId dans son membre pScopes .

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_SCOPE_NOT_IN_RELATIONSHIP
 Le sous-réseau IPv4 ne fait pas partie de la relation de basculement.

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

DhcpV4FailoverAddScopeToRelationship

DhcpV4FailoverDeleteScopeFromRelationship

DhcpV4FailoverGetScopeStatistics