MprConfigInterfaceTransportEnum, fonction (mprapi.h)

Article
08/24/2023

La fonction MprConfigInterfaceTransportEnum énumère les transports configurés sur l’interface spécifiée.

Syntaxe

DWORD MprConfigInterfaceTransportEnum(
  [in]                HANDLE  hMprConfig,
  [in]                HANDLE  hRouterInterface,
  [in]                DWORD   dwLevel,
  [in, out]           LPBYTE  *lplpBuffer,
  [in]                DWORD   dwPrefMaxLen,
  [out]               LPDWORD lpdwEntriesRead,
  [out]               LPDWORD lpdwTotalEntries,
  [in, out, optional] LPDWORD lpdwResumeHandle
);

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 à partir de laquelle énumérer les transports. Obtenez ce handle en appelant MprConfigInterfaceCreate ou MprConfigInterfaceEnum.

[in] dwLevel

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

[in, out] lplpBuffer

Lors de l’entrée, pointeur non NULL .

Une fois l’achèvement réussi, pointeur vers un tableau de structures MPR_IFTRANSPORT_0 . Libérez cette mémoire tampon en appelant MprConfigBufferFree.

[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’entrées énumérées à partir de la position de reprise actuelle.

[out] lpdwTotalEntries

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

[in, out, optional] lpdwResumeHandle

Pointeur vers une variable DWORD .

Lors de l’entrée, le handle doit être égal à zéro lors du premier appel et laisser inchangé lors des appels suivants.

Sur la sortie, cette variable contient un handle de reprise utilisé pour continuer l’énumération. Si le handle est NULL, l’énumération est terminée.

Si une erreur se produit dans l’énumération, 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_INVALID_PARAMETER	Une des conditions suivantes est vraie : hMprConfig a la valeur NULL. HRouterInterface a la valeur NULL. dwLevel n’est pas égal à zéro. lplpBuffer a la valeur NULL. dwPrefMaxLen est plus petit que la taille d’une structure de MPR_IFTRANSPORT_0 unique. lpdwEntriesRead a la valeur NULL. lpdwTotalEntries a la valeur NULL.
ERROR_NOT_ENOUGH_MEMORY	Ressources insuffisantes pour terminer l’opération.
ERROR_NO_MORE_ITEMS	Il n’y a plus d’entrées disponibles à partir de la position actuelle du CV.
Autres	Utilisez FormatMessage pour récupérer le message d’erreur système qui correspond au code d’erreur retourné.

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