Fonction MprAdminConnectionGetInfo (mprapi.h)

Article
02/29/2024

La fonction MprAdminConnectionGetInfo récupère les données relatives à une connexion spécifique.

Syntaxe

DWORD MprAdminConnectionGetInfo(
  [in]  RAS_SERVER_HANDLE hRasServer,
  [in]  DWORD             dwLevel,
  [in]  HANDLE            hRasConnection,
  [out] LPBYTE            *lplpbBuffer
);

Paramètres

[in] hRasServer

Handle vers l’ordinateur à partir duquel les informations de connexion sont récupérées. Pour obtenir ce handle, appelez MprAdminServerConnect.

[in] dwLevel

Valeur DWORD qui décrit le format dans lequel les informations sont retournées dans le paramètre lplpbBuffer . Les valeurs acceptables pour dwLevel incluent 0, 1, 2 et 3, comme indiqué dans le tableau suivant.

Windows NT 4.0 : Ce paramètre doit être égal à zéro.

Valeur	Structure Format
0	RAS_CONNECTION_0
1	Windows 2000 ou version ultérieure : RAS_CONNECTION_1
2	Windows 2000 ou version ultérieure : RAS_CONNECTION_2
3	Windows Server 2008 ou version ultérieure : RAS_CONNECTION_3

[in] hRasConnection

Handle de la connexion pour récupérer des données. Pour obtenir ce handle, appelez MprAdminConnectionEnum.

[out] lplpbBuffer

En cas d’achèvement réussi, pointeur vers un tableau de structures qui décrivent la connexion. Ces structures sont de type RAS_CONNECTION_0, RAS_CONNECTION_1, RAS_CONNECTION_2 ou RAS_CONNECTION_3, selon la valeur du paramètre dwLevel .

Pour libérer cette mémoire, appelez MprAdminBufferFree.

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 répertoriés dans le tableau suivant.

Code de retour	Description
ERROR_INVALID_PARAMETER	Le handle du serveur RAS ou le handle de la connexion RAS n’est pas valide.
ERROR_INVALID_LEVEL	La valeur passée pour dwLevel n’est pas zéro, un, deux ou trois. Les niveaux 1 et 2 sont pris en charge uniquement sur Windows 2000 ou version ultérieure. Le niveau 3 est pris en charge uniquement sur Windows Server 2008 ou version ultérieure.
ERROR_INTERFACE_NOT_CONNECTED	Le handle hConnection n’est pas valide.
RPC_S_INVALID_BINDING	Le handle hRasServer n’est pas valide.
Autres	Erreur de MprError.h, RasError.h ou WinError.h.

Remarques

Cette fonction est disponible sur Windows NT 4.0 si le redistribuable RRAS est installé. Toutefois, la version de Mprapi.dll incluse dans le RRAS redistributable exporte la fonction en tant que RasAdminConnectionGetInfo plutôt que MprAdminConnectionGetInfo. Par conséquent, lorsque vous utilisez le redistribuable RRAS, utilisez LoadLibrary et GetProcAddress pour accéder à cette fonction.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
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