Fonction MprConfigTransportGetInfo (mprapi.h)

Article
08/24/2023

La fonction MprConfigTransportGetInfo récupère la configuration du protocole de transport spécifié à partir du routeur.

Syntaxe

DWORD MprConfigTransportGetInfo(
  [in]                HANDLE  hMprConfig,
  [in]                HANDLE  hRouterTransport,
  [in, out, optional] LPBYTE  *ppGlobalInfo,
  [out, optional]     LPDWORD lpdwGlobalInfoSize,
  [in, out, optional] LPBYTE  *ppClientInterfaceInfo,
  [out, optional]     LPDWORD lpdwClientInterfaceInfoSize,
  [in, out, optional] LPWSTR  *lplpwsDLLPath
);

Paramètres

[in] hMprConfig

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

[in] hRouterTransport

Gérez la configuration du protocole de transport en cours de récupération. Pour obtenir ce handle, appelez MprConfigTransportCreate, MprConfigTransportGetHandle ou MprConfigTransportEnum. Les types de protocole de transport pris en charge sont répertoriés dans Identificateurs de transport.

[in, out, optional] ppGlobalInfo

En entrée, pointeur vers une variable de pointeur.

À la sortie, cette variable pointeur pointe vers un en-tête d’informations qui contient des informations globales pour le transport. Utilisez les fonctions d’en-tête d’informations pour manipuler les en-têtes d’informations. Libérez cette mémoire tampon en appelant MprConfigBufferFree.

Ce paramètre est facultatif. Si l’application appelante spécifie NULL pour ce paramètre, la fonction ne récupère pas les informations globales.

[out, optional] lpdwGlobalInfoSize

Pointeur vers une variable DWORD . Cette variable reçoit la taille, en octets, de la mémoire tampon retournée par le biais du paramètre ppGlobalInfo .

Ce paramètre est facultatif ; l’application appelante peut spécifier NULL pour ce paramètre. Toutefois, si ppGlobalInfo n’a pas la valeur NULL, ce paramètre ne peut pas être NULL.

[in, out, optional] ppClientInterfaceInfo

En entrée, pointeur vers une variable de pointeur.

En sortie, ce pointeur pointe vers un en-tête d’informations qui contient des informations d’interface par défaut pour les routeurs clients pour ce transport. Utilisez les fonctions d’en-tête d’informations pour manipuler les en-têtes d’informations. Libérez la mémoire tampon en appelant MprConfigBufferFree.

Ce paramètre est facultatif. Si l’application appelante spécifie NULL pour ce paramètre, la fonction ne récupère pas les informations d’interface.

[out, optional] lpdwClientInterfaceInfoSize

Pointeur vers une variable DWORD . Cette variable reçoit la taille, en octets, de la mémoire tampon retournée via le paramètre ppClientInterfaceInfo .

Ce paramètre est facultatif ; l’application appelante peut spécifier NULL pour ce paramètre. Toutefois, si ppClientInterfaceInfo n’a pas la valeur NULL, ce paramètre ne peut pas être NULL.

[in, out, optional] lplpwsDLLPath

En entrée, pointeur vers un pointeur vers une chaîne Unicode terminée par null.

À la sortie, la chaîne Unicode reçoit le nom de la DLL du gestionnaire de routeur pour le transport spécifié.

Ce paramètre est facultatif. Si l’application appelante spécifie NULL pour ce paramètre, la fonction ne récupère pas le nom de la DLL du gestionnaire de routeur.

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 hRouterTransport a la valeur NULL ppGlobalInfo n’a pas la valeur NULL, mais lpdwGlobalInfoSize a la valeur NULL. ppClientInterfaceInfo n’a pas la valeur NULL, mais lpdwClientInterfaceInfo a la valeur NULL.
ERROR_UNKNOWN_PROTOCOL_ID	La configuration du protocole de transport qui correspond à hRouterTransport n’a pas été trouvée dans la configuration du routeur.
ERROR_NOT_ENOUGH_MEMORY	Ressources insuffisantes pour terminer l’opération.
Autres	Utilisez FormatMessage pour récupérer le message d’erreur système qui correspond au code d’erreur retourné.

Notes

Si les paramètres pGlobalInfo, pClientInterfaceInfo et lpwsDLLPath ont tous la valeur NULL, la fonction ne fait rien et retourne une valeur de NO_ERROR.

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