PGET_INTERFACE_INFO fonction de rappel (routprot.h)

Article
03/01/2024

La fonction GetInterfaceInfo obtient les informations de configuration conservées par le protocole de routage pour une interface spécifique.

Syntaxe

PGET_INTERFACE_INFO PgetInterfaceInfo;

DWORD PgetInterfaceInfo(
  [in]      ULONG InterfaceIndex,
  [in]      PVOID InterfaceInfo,
  [in, out] PULONG BufferSize,
  [in]      PULONG StructureVersion,
  [in]      PULONG StructureSize,
  [in]      PULONG StructureCount
)
{...}

Paramètres

[in] InterfaceIndex

Spécifie l’interface dans l’ensemble d’interfaces configurées sur le routeur.

[in] InterfaceInfo

Pointeur vers une mémoire tampon qui reçoit les informations de configuration définies par protocole associées à l’interface. Ces informations sont privées au protocole de routage.

[in, out] BufferSize

Pointeur vers une variable DWORD .

En entrée : cette variable spécifie la taille, en octets, de la mémoire tampon fournie pour recevoir les informations de configuration.

En sortie : cette variable reçoit la taille, en octets, des données placées dans la mémoire tampon. Si la taille initiale n’était pas suffisamment grande, cette variable contient la taille nécessaire pour contenir toutes les données.

[in] StructureVersion

Spécifie la version des structures d’informations pointées par le paramètre InterfaceInfo . Dans certains cas, cela est égal à la version du protocole de routage.

[in] StructureSize

Spécifie la taille de chacune des structures d’informations pointées par le paramètre InterfaceInfo . Étant donné que certaines structures d’informations contiennent des membres de longueur variable, le protocole de routage n’est pas nécessairement en mesure de déterminer la taille des informations de la version.

[in] StructureCount

Spécifie le nombre de structures d’informations pointées par le paramètre InterfaceInfo . Ce paramètre est toujours un.

Valeur retournée

Si la fonction réussit, la valeur de retour est NO_ERROR.

Si la fonction échoue, la valeur de retour est l’un des codes d’erreur suivants.

Valeur	Description
ERROR_CAN_NOT_COMPLETE	Échec de la tentative de récupération des informations.
ERROR_INVALID_PARAMETER	Le paramètre InterfaceIndex n’est pas valide (par exemple, il n’existe aucune interface avec cet index) ou le paramètre InterfaceInfoSize a la valeur NULL.
ERROR_INSUFFICIENT_BUFFER	La taille de la mémoire tampon de sortie fournie n’est pas suffisante pour contenir les informations demandées. La taille requise est retournée dans la variable DWORD pointée par InterfaceInfoSize.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Aucun pris en charge
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	routprot.h

Voir aussi

Fonctions d’interface de protocole de routage

Informations de référence sur l’interface de protocole de routage

SetInterfaceInfo

Partager via