Fonction MprAdminConnectionEnum (mprapi.h)

Article
02/29/2024

La fonction MprAdminConnectionEnum énumère toutes les connexions actives.

Syntaxe

DWORD MprAdminConnectionEnum(
  [in]  RAS_SERVER_HANDLE hRasServer,
  [in]  DWORD             dwLevel,
  [out] LPBYTE            *lplpbBuffer,
  [in]  DWORD             dwPrefMaxLen,
  [out] LPDWORD           lpdwEntriesRead,
  [out] LPDWORD           lpdwTotalEntries,
  [in]  LPDWORD           lpdwResumeHandle
);

Paramètres

[in] hRasServer

Gérez vers le serveur RAS sur lequel les connexions sont énumérées. Obtenez ce handle en appelant 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

[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.

[in] dwPrefMaxLen

Spécifie la longueur maximale préférée des données retournées en octets 8 bits. Si dwPrefMaxLen a la valeur -1, la mémoire tampon retournée est suffisamment grande pour contenir toutes les informations disponibles.

[out] lpdwEntriesRead

Pointeur vers une variable DWORD . Cette variable reçoit le nombre total de connexions énumérées à partir de la position de reprise actuelle.

[out] lpdwTotalEntries

Pointeur vers une variable DWORD . Cette variable reçoit le nombre total de connexions qui auraient pu être énumérées à partir de la position de reprise actuelle.

[in] lpdwResumeHandle

Pointeur vers une variable DWORD . Cette variable spécifie un handle de cv utilisé pour continuer l’énumération. Le paramètre lpdwResumeHandle est égal à zéro lors du premier appel et est resté inchangé lors des appels suivants. Si le code de retour est ERROR_MORE_DATA, un autre appel peut être effectué à l’aide de ce handle pour récupérer plus de données. Si le handle a la valeur NULL au retour, l’énumération est terminée. Ce handle n’est pas valide pour d’autres types de retours d’erreur.

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_DDM_NOT_RUNNING	Le Gestionnaire de numérotation de la demande (DDM) n’est pas en cours d’exécution, peut-être parce que le Gestionnaire d’interface dynamique (DIM) est configuré pour s’exécuter uniquement sur un réseau local.
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_INVALID_PARAMETER	Au moins un des paramètres suivants a la valeur NULL ou ne pointe pas vers la mémoire valide : lplpBuffer, lpdwEntriesRead ou lpdwTotalEntries.
ERROR_MORE_DATA	Toutes les données n’ont pas été retournées avec cet appel. Pour obtenir des données supplémentaires, appelez à nouveau la fonction à l’aide du handle de cv.
RPC_S_INVALID_BINDING	Le handle transmis dans le paramètre hRasServer est NULL ou non 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 fournie avec le RRAS redistribuable exporte la fonction en tant que RasAdminConnectionEnum plutôt que MprAdminConnectionEnum. 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