Fonction MprConfigInterfaceTransportGetInfo (mprapi.h)

Article
08/24/2023

La fonction MprConfigInterfaceTransportGetInfo récupère les informations de configuration du client spécifié sur l’interface spécifiée.

Syntaxe

DWORD MprConfigInterfaceTransportGetInfo(
  [in]                HANDLE  hMprConfig,
  [in]                HANDLE  hRouterInterface,
  [in]                HANDLE  hRouterIfTransport,
  [in, out, optional] LPBYTE  *ppInterfaceInfo,
  [out, optional]     LPDWORD lpdwInterfaceInfoSize
);

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 récupérer les informations client spécifiées. Pour obtenir ce handle, appelez MprConfigInterfaceCreate, MprConfigInterfaceGetHandle ou MprConfigInterfaceEnum.

[in] hRouterIfTransport

Gérez la configuration de transport à partir de laquelle récupérer les informations client spécifiées. Pour obtenir ce handle, appelez MprConfigInterfaceTransportAdd, MprConfigInterfaceTransportGetHandle ou MprConfigInterfaceTransportEnum. Les types de protocole de transport pris en charge sont répertoriés dans Identificateurs de transport.

[in, out, optional] ppInterfaceInfo

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 de configuration pour le client. Utilisez les fonctions d’en-tête d’informations pour manipuler les en-têtes d’informations. Libérez cette mémoire en appelant MprConfigBufferFree.

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

[out, optional] lpdwInterfaceInfoSize

Pointeur vers une variable DWORD . Cette variable reçoit la taille, en octets, des données pointées par ppInterfaceInfo.

Ce paramètre est facultatif ; l’application appelante peut spécifier NULL pour ce paramètre. Toutefois, si ppInterfaceInfo n’a pas la valeur NULL, ce paramètre ne peut pas être NULL. Pour plus d'informations, consultez la section « Notes » plus loin dans cette rubrique.

Valeur retournée

Si la fonction réussit, la valeur de retour est NO_ERROR. Pour plus d'informations, consultez la section « Notes » plus loin dans cette rubrique.

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. hRouterIfTransport a la valeur NULL. ppInterfaceInfo n’a pas la valeur NULL, mais lpdwInterfaceInfoSize a la valeur NULL.
ERROR_NO_SUCH_INTERFACE	L’interface spécifiée par hRouterIfTransport n’a pas été trouvée dans la configuration du routeur, ou le transport spécifié par hRouterIfTransport n’était pas activé sur l’interface spécifiée.
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 le paramètre ppInterfaceInfo a la valeur NULL, MprConfigInterfaceTransportGetInfo ne fait rien et retourne immédiatement avec 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