DhcpV4GetOptionValue, fonction (dhcpsapi.h)

  • Article

La fonction DhcpV4GetOptionValue récupère une valeur d’option DHCP (le code d’option et les données associées) pour une étendue particulière. Cette fonction étend les fonctionnalités fournies par DhcpGetOptionValueV5 en autorisant l’appelant à spécifier une stratégie pour l’option.

Syntaxe

DWORD DHCP_API_FUNCTION DhcpV4GetOptionValue(
  [in, optional] LPWSTR                   ServerIpAddress,
  [in]           DWORD                    Flags,
  [in]           DHCP_OPTION_ID           OptionID,
  [in, optional] LPWSTR                   PolicyName,
  [in, optional] LPWSTR                   VendorName,
  [in]           LPDHCP_OPTION_SCOPE_INFO ScopeInfo,
  [out]          LPDHCP_OPTION_VALUE      *OptionValue
);

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] Flags

Indique si l’option est destinée à un fournisseur spécifique ou par défaut.

Indicateurs Signification
0x00000000
 La valeur de l’option est récupérée pour un fournisseur par défaut.
DHCP_FLAGS_OPTION_IS_VENDOR
0x00000003
 La valeur de l’option est récupérée pour un fournisseur spécifique. Le fournisseur est dans VendorName.

[in] OptionID

DHCP_OPTION_ID structure qui spécifie le code d’option unique pour la valeur d’option à récupérer. Vous trouverez la liste complète des codes d’option DHCP et BOOTP standard à l’adresse http://www.ietf.org/rfc/rfc2132.txt

[in, optional] PolicyName

Chaîne Unicode terminée par un caractère Null qui représente le nom de la stratégie à l’intérieur du sous-réseau de la valeur d’option à récupérer. Le sous-réseau est identifié par le membre SubnetScopeInfo de ScopeInfo.

[in, optional] VendorName

Chaîne Unicode terminée par null qui représente le fournisseur de l’option. Ce paramètre est facultatif et doit avoir la valeur NULL lorsque les indicateurs ne sont pas DHCP_FLAGS_OPTION_IS_VENDOR. Si le fournisseur n’est pas spécifié, la valeur d’option est retournée pour le fournisseur par défaut.

[in] ScopeInfo

DHCP_OPTION_SCOPE_INFO structure qui contient des informations sur l’étendue de la valeur d’option à récupérer.

[out] OptionValue

Pointeur vers une structure DHCP_OPTION_DATA qui contient la valeur de données correspondant au code d’option DHCP spécifié par OptionID.

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_SUBNET_NOT_PRESENT
 Le sous-réseau IPv4 spécifié n’existe pas.
ERROR_DHCP_CLASS_NOT_FOUND
 Le nom de la classe utilisée est inconnu ou incorrect.
ERROR_DHCP_POLICY_NOT_FOUND
 Le nom de stratégie spécifié n’existe pas.
ERROR_DHCP_OPTION_NOT_PRESENT
 La définition d’option spécifiée n’existe pas sur la base de données du serveur DHCP.

Notes

OptionValue doit être gratuit à l’aide de DhcpRpcFreeMemory.

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

DhcpV4GetAllOptionValues

DhcpV4RemoveOptionValue

DhcpV4SetOptionValue

DhcpV4SetOptionValues