MprAdminInterfaceEnum, fonction (mprapi.h)

Article
02/29/2024

La fonction MprAdminInterfaceEnum énumère toutes les interfaces sur un serveur spécifié.

Syntaxe

DWORD MprAdminInterfaceEnum(
  [in]  MPR_SERVER_HANDLE hMprServer,
  [in]  DWORD             dwLevel,
  [out] LPBYTE            *lplpbBuffer,
  [in]  DWORD             dwPrefMaxLen,
  [out] LPDWORD           lpdwEntriesRead,
  [out] LPDWORD           lpdwTotalEntries,
  [in]  LPDWORD           lpdwResumeHandle
);

Paramètres

[in] hMprServer

Gérez le routeur sur lequel exécuter cet appel. Obtenez ce handle en appelant MprAdminServerConnect.

[in] dwLevel

Valeur DWORD qui décrit le format dans lequel les informations sont retournées dans le paramètre lplpbBuffer . Doit être zéro.

[out] lplpbBuffer

En cas de réussite, pointeur vers un tableau de structures MPR_INTERFACE_0 . Libérez cette mémoire tampon en appelant MprAdminBufferFree.

[in] dwPrefMaxLen

Spécifie la longueur maximale par défaut des données retournées (en octets de 8 bits). Si ce paramètre a la valeur -1, la mémoire tampon retournée est suffisamment grande pour contenir toutes les informations disponibles.

[out] lpdwEntriesRead

Pointeur vers une variable DWORD . Cette variable reçoit le nombre total d’interfaces qui ont été énumérées à partir de la position actuelle dans l’énumération.

[out] lpdwTotalEntries

Pointeur vers une variable DWORD . Cette variable reçoit le nombre total d’interfaces qui auraient pu être énumérées à partir de la position de reprise actuelle.

[in] lpdwResumeHandle

Pointeur vers une variable DWORD . Cette variable spécifie un handle de reprise qui peut être utilisé pour poursuivre l’énumération. Le handle doit être égal à zéro lors du premier appel et laissé inchangé lors des appels suivants. Si le code de retour est ERROR_MORE_DATA l’appel peut être réexécré à l’aide du handle pour récupérer plus de données. Si au retour, le handle est NULL, l’énumération ne peut pas être poursuivie. Pour les autres types de retours d’erreur, ce handle n’est pas valide.

Ce paramètre est facultatif. Si l’application appelante spécifie NULL pour ce paramètre, la fonction ne retourne pas de handle de reprise.

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_ACCESS_DENIED	L’application appelante ne dispose pas de privilèges suffisants.
ERROR_MORE_DATA	Plus d’informations sont disponibles ; l’énumération peut être poursuivie.
ERROR_NOT_ENOUGH_MEMORY	Ressources insuffisantes pour terminer l’opération.
ERROR_NOT_SUPPORTED	La valeur de dwLevel n’est pas valide.

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

Voir aussi

MPR_INTERFACE_0

MprAdminBufferFree

MprAdminServerConnect

Fonctions d’administration du routeur

Informations de référence sur la gestion des routeurs

Share via