Fonction MprConfigTransportEnum (mprapi.h)

Article
03/13/2024

La fonction MprConfigTransportEnum énumère les transports configurés sur le routeur.

Syntaxe

DWORD MprConfigTransportEnum(
  [in]                HANDLE  hMprConfig,
  [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 pour les transports. Obtenez ce handle en appelant MprConfigServerConnect.

[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

En entrée, pointeur non NULL .

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

[in] dwPrefMaxLen

Spécifie la longueur maximale préférée des données retournées en octets 8 bits. Si ce paramètre est -1, la mémoire tampon retournée sera 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 qui ont été énumérées à partir de la position actuelle du CV.

[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 actuelle du CV.

[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 laissé inchangé lors des appels suivants.

Sur la sortie, cette variable contient un handle de CV utilisé pour continuer l’énumération. Si le handle a la valeur 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 d’activité.

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. dwLevel n’est pas égal à zéro. lplpBuffer a la valeur NULL. dwPrefMaxLen est plus petit que la taille d’une structure MPR_TRANSPORT_0 unique. lpdwEntriesRead a lavaleur NULL. lpdwTotalEntries a lavaleur NULL.
ERROR_NOT_ENOUGH_MEMORY	Ressources insuffisantes pour terminer l’opération.
ERROR_NO_MORE_ITEMS	Plus d’entrées disponibles à partir de la position de CV actuelle.
Autres	Utilisez FormatMessage pour récupérer le message d’erreur système qui correspond au code d’erreur retourné.

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

FormatMessage

MprConfigBufferFree

MprConfigServerConnect

Fonctions de configuration du routeur

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

Partager via