Fonction DhcpV4FailoverEnumRelationship (dhcpsapi.h)
La fonction DhcpV4FailoverEnumRelationship énumère toutes les relations de basculement présentes sur le serveur.
Syntaxe
DWORD DHCP_API_FUNCTION DhcpV4FailoverEnumRelationship(
[in, optional] LPWSTR ServerIpAddress,
[in, out] DHCP_RESUME_HANDLE *ResumeHandle,
[in] DWORD PreferredMaximum,
[out] LPDHCP_FAILOVER_RELATIONSHIP_ARRAY *pRelationship,
[out] LPDWORD RelationshipRead,
[out] LPDWORD RelationshipTotal
);
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, out] ResumeHandle
Pointeur vers une structure de DHCP_RESUME_HANDLE qui identifie cette énumération pour une utilisation dans les appels suivants à cette fonction.
Initialement, cette valeur doit être égale à zéro en entrée. En cas de réussite, la valeur retournée doit être utilisée pour les demandes d’énumération suivantes. Par exemple, si PreferredMaximum a la valeur 100 et que 200 éléments de réservation sont configurés sur le serveur, le handle de cv peut être utilisé après la récupération des 100 premières stratégies pour obtenir les 100 suivantes lors d’un appel suivant.
[in] PreferredMaximum
Nombre maximal d’éléments de relation de basculement à retourner dans pRelationship. Si PreferredMaximum est supérieur au nombre de stratégies non énumérées restantes sur le serveur, le nombre restant de stratégies non énumérées est retourné.
[out] pRelationship
Pointeur vers une structure DHCP_FAILOVER_RELATIONSHIP_ARRAY qui contient un tableau des relations de basculement disponibles sur le serveur DHCP. Si aucune relation n’est configurée, cette valeur est NULL.
[out] RelationshipRead
Pointeur vers un DWORD qui spécifie le nombre d’éléments de relation de basculement retournés dans pRelationship.
[out] RelationshipTotal
Pointeur vers un DWORD qui spécifie le nombre de relations de basculement configurées sur le serveur DHCP qui n’ont pas encore été énumérées.
Valeur retournée
Si la fonction réussit, elle retourne ERROR_SUCCESS.
Si la fonction échoue, elle retourne l’un des éléments suivants. ou un code d’erreur provenant des codes d’erreur de l’API gestion du serveur DHCP
Valeur | Signification |
---|---|
|
Un ou plusieurs des paramètres n’étaient pas valides. |
|
Il existe d’autres éléments disponibles pour énumérer. |
|
Il ne reste plus d’éléments à énumérer. |
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