Fonction MprAdminConnectionEnumEx (mprapi.h)

Article
03/04/2024

La fonction MprAdminConnectionEnumEx énumère les connexions actives pour un serveur RRAS spécifié.

Syntaxe

DWORD MprAdminConnectionEnumEx(
  [in]  RAS_SERVER_HANDLE     hRasServer,
  [in]  PMPRAPI_OBJECT_HEADER pObjectHeader,
  [in]  DWORD                 dwPreferedMaxLen,
  [out] LPDWORD               lpdwEntriesRead,
  [out] LPDWORD               lpdwTotalEntries,
  [out] PRAS_CONNECTION_EX    *ppRasConn,
  [in]  LPDWORD               lpdwResumeHandle
);

Paramètres

[in] hRasServer

Handle du serveur RAS sur lequel les connexions sont énumérées. Obtenez ce handle en appelant MprAdminServerConnect.

[in] pObjectHeader

Pointeur vers une structure MPRAPI_OBJECT_HEADER qui spécifie la version de structure reçue par ppRasConn.

[in] dwPreferedMaxLen

Valeur qui spécifie la longueur maximale préférée des données retournées en octets de 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 un DWORD qui reçoit le nombre total de connexions énumérées à partir de la position de reprise actuelle.

[out] lpdwTotalEntries

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

[out] ppRasConn

Pointeur, en sortie, vers un tableau de structures RAS_CONNECTION_EX qui contiennent les informations de connexion actives pour le serveur RRAS dans hRasServer. Le nombre d’éléments de tableau est déterminé par la valeur pointée par lpdwEntriesRead.

[in] lpdwResumeHandle

Pointeur vers une variable DWORD qui spécifie un handle de cv utilisé pour continuer l’énumération. Le paramètre lpdwResumeHandle a la valeur NULL 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_ACCESS_DENIED	L’application appelante ne dispose pas de privilèges suffisants.
ERROR_DDM_NOT_RUNNING	Le Gestionnaire de numérotation de la demande (DDM) n’est pas en cours d’exécution.
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.
ERROR_PROC_NOT_FOUND	La procédure spécifiée est introuvable.
Autres	Erreur de MprError.h, RasError.h ou WinError.h.

Remarques

L’appelant doit libérer la mémoire pointée par ppRasConn en appelant la fonction MprAdminBufferFree.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 7 [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2008 R2 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	mprapi.h
Bibliothèque	Mprapi.lib
DLL	Mprapi.dll

Voir aussi

MprAdminBufferFree

MprAdminConnectionEnum

MprAdminServerConnect

Fonctions d’administration RAS

Informations de référence sur l’administration du service d’accès à distance