MprAdminTransportGetInfo, fonction (mprapi.h)

Article
03/06/2024

La fonction MprAdminTransportGetInfo récupère des informations globales, des informations d’interface client par défaut, ou les deux, pour un transport spécifié.

Syntaxe

DWORD MprAdminTransportGetInfo(
  [in]            MPR_SERVER_HANDLE hMprServer,
  [in]            DWORD             dwTransportId,
  [out, optional] LPBYTE            *ppGlobalInfo,
  [out, optional] LPDWORD           lpdwGlobalInfoSize,
  [out, optional] LPBYTE            *ppClientInterfaceInfo,
  [out, optional] LPDWORD           lpdwClientInterfaceInfoSize
);

Paramètres

[in] hMprServer

Gérez le routeur à partir duquel les informations sont récupérées. Ce handle est obtenu à partir d’un appel précédent à MprAdminServerConnect.

[in] dwTransportId

Valeur DWORD qui décrit le type de transport à récupérer. Les valeurs acceptables pour dwTransportId sont répertoriées dans le tableau suivant.

Valeur	Transport (famille de protocoles)
PID_ATALK	Appletalk
PID_IP	Protocole Internet version 4
PID_IPX	Internet Packet Exchange
PID_NBF	NetBIOS Frames Protocol
PID_IPV6	Windows Server 2008 ou version ultérieure : Protocole Internet version 6

[out, optional] ppGlobalInfo

Pointeur vers une variable pointeur. Cette variable pointe vers un en-tête d’informations qui reçoit des informations globales pour ce transport. Utilisez les fonctions d’en-tête d’informations pour manipuler les en-têtes d’informations.

Libérez cette mémoire en appelant MprAdminBufferFree.

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, des informations globales pour le transport.

[out, optional] ppClientInterfaceInfo

Pointeur vers une variable pointeur. Cette variable pointe vers les informations d’interface client par défaut pour ce transport. Libérez cette mémoire en appelant MprAdminBufferFree.

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 de l’interface client.

[out, optional] lpdwClientInterfaceInfoSize

Pointeur vers une variable DWORD . Cette variable reçoit la taille, en octets, des informations de l’interface cliente.

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_INVALID_PARAMETER	Une des conditions suivantes est vraie : Le paramètre ppGlobalInfo et le paramètre ppClientInterfaceInfo ont tous deux la valeur NULL. Le paramètre ppGlobalInfo ne pointe pas vers la mémoire valide. Le paramètre ppClientInterfaceInfo ne pointe pas vers la mémoire valide.
ERROR_NOT_ENOUGH_MEMORY	Ressources insuffisantes pour terminer l’opération.
ERROR_UNKNOWN_PROTOCOL_ID	La valeur dwTransportId ne correspond à aucun transport installé.

Remarques

Les paramètres ppGlobalInfo et ppClientInterfaceInfo ne peuvent pas tous les deux être NULL.

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