DhcpGetOptionValueV6, fonction (dhcpsapi.h)

  • Article

La fonction DhcpGetOptionValueV6 récupère la valeur d’option d’une option spécifique définie sur le serveur DHCPv6 pour une classe d’utilisateur ou de fournisseur spécifique.

Syntaxe

DWORD DhcpGetOptionValueV6(
  [in]  LPWSTR                    ServerIpAddress,
  [in]  DWORD                     Flags,
  [in]  DHCP_OPTION_ID            OptionID,
  [in]  LPWSTR                    ClassName,
  [in]  LPWSTR                    VendorName,
  [in]  LPDHCP_OPTION_SCOPE_INFO6 ScopeInfo,
  [out] LPDHCP_OPTION_VALUE       *OptionValue
);

Paramètres

[in] ServerIpAddress

Chaîne Unicode qui spécifie l’adresse IPv6 ou le nom d’hôte du serveur DHCPv6.

[in] Flags

Valeur d’indicateur qui indique si l’option concerne une classe de fournisseur spécifique ou par défaut.

Valeur Signification
0x00000000
 La valeur d’option est récupérée pour une classe de fournisseur par défaut.
DHCP_FLAGS_OPTION_IS_VENDOR
0x00000003
 La valeur de l’option est récupérée pour une classe de fournisseur spécifique. Le nom du fournisseur est fourni dans VendorName.

[in] OptionID

DHCP_OPTION_ID valeur qui spécifie l’identificateur d’option pour l’option récupérée.

[in] ClassName

Pointeur vers une chaîne Unicode terminée par un caractère Null qui contient le nom de la classe utilisateur pour laquelle la valeur d’option est demandée. Ce paramètre est facultatif.

[in] VendorName

Pointeur vers une chaîne Unicode terminée par null qui contient le nom de la classe de fournisseur pour laquelle la valeur d’option est demandée. Ce paramètre est facultatif ; si aucune valeur n’est spécifiée, la classe de fournisseur par défaut est supposée.

[in] ScopeInfo

Pointeur vers une structure de DHCP_OPTION_SCOPE_INFO6 qui contient des informations sur l’étendue DHCPv6 pour laquelle l’option est une valeur est demandée. Plus précisément, il définit si l’option est récupérée pour le niveau par défaut, serveur ou étendue, ou pour une réservation IPv6 spécifique.

[out] OptionValue

Pointeur vers l’adresse d’une structure DHCP_OPTION_VALUE retournée par l’opération et qui contient la valeur d’option correspondant à OptionID.

Valeur retournée

Cette fonction retourne ERROR_SUCCESS en cas d’appel réussi. Sinon, elle retourne l’un des codes d’erreur de l’API Gestion du serveur DHCP.

Code de retour Description
ERROR_ACCESS_DENIED
 Cet appel a été effectué par un client qui n’est pas membre du groupe de sécurité « Administrateurs DHCP ».
ERROR_FILE_NOT_FOUND
 Le système ne trouve pas le fichier spécifié.
ERROR_DHCP_SUBNET_NOT_PRESENT
 Le sous-réseau spécifié n’est pas défini sur le serveur DHCPv6.
ERROR_DHCP_OPTION_NOT_PRESENT
 L’option spécifiée n’est pas définie au niveau spécifié sur le serveur DHCPv6.
ERROR_DHCP_NOT_RESERVED_CLIENT
 Le client IPv6 réservé n’est pas défini sur le serveur DHCPv6.

Notes

L’appelant de cette fonction doit libérer la mémoire pointée par OptionValue.

Spécifications

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

Voir aussi

DHCP_OPTION_SCOPE_INFO6