Fonction MprConfigInterfaceGetInfo (mprapi.h)

Article
08/24/2023

La fonction MprConfigInterfaceGetInfo récupère la configuration de l’interface spécifiée à partir du routeur.

Syntaxe

DWORD MprConfigInterfaceGetInfo(
  [in]      HANDLE  hMprConfig,
  [in]      HANDLE  hRouterInterface,
  [in]      DWORD   dwLevel,
  [in, out] LPBYTE  *lplpBuffer,
  [out]     LPDWORD lpdwBufferSize
);

Paramètres

[in] hMprConfig

Gérez la configuration du routeur. Obtenez ce handle en appelant MprConfigServerConnect.

[in] hRouterInterface

Gérez la configuration de l’interface pour laquelle récupérer des informations. Pour obtenir ce handle, appelez MprConfigInterfaceCreate, MprConfigInterfaceGetHandle ou MprConfigInterfaceEnum.

[in] dwLevel

Valeur DWORD qui décrit le format dans lequel les informations sont retournées dans le paramètre lplpBuffer . Les valeurs acceptables pour dwLevel incluent 0, 1, 2 et 3, comme indiqué dans le tableau suivant.

Valeur	Structure Format
0	MPR_INTERFACE_0
1	MPR_INTERFACE_1
2	MPR_INTERFACE_2
3	Windows Server 2008 ou version ultérieure : MPR_INTERFACE_3

[in, out] lplpBuffer

En entrée, pointeur non NULL .

Une fois la saisie terminée, un pointeur vers un tableau de MPR_INTERFACE_0, MPR_INTERFACE_1,
MPR_INTERFACE_2 ou structure MPR_INTERFACE_3 . Le paramètre dwLevel indique le type de structure. Libérez cette mémoire tampon en appelant MprConfigBufferFree.

[out] lpdwBufferSize

Pointeur vers une variable DWORD . Cette variable reçoit la taille, en octets, des données retournées via lplpBuffer.

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	Signification
ERROR_INVALID_PARAMETER	Au moins un des éléments suivants est vrai : hMprConfig a la valeur NULL hRouterInterface a la valeurNULL dwLevel n’est pas 0, 1, 2 ou 3. lplpBuffer a la valeur NULL lpdwBufferSize a la valeur NULL
ERROR_NOT_ENOUGH_MEMORY	Ressources insuffisantes pour terminer l’opération.
ERROR_NO_SUCH_INTERFACE	L’interface qui correspond à hRouterInterface n’est pas présente dans la configuration du routeur.

Spécifications


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	mprapi.h
Bibliothèque	Mprapi.lib
DLL	Mprapi.dll