Fonction MprAdminPortEnum (mprapi.h)

  • Article

La fonction MprAdminPortEnum énumère tous les ports actifs dans une connexion spécifique, ou tous les ports disponibles ou actuellement utilisés par RAS.

Syntaxe

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

Paramètres

[in] hRasServer

Handle pour le serveur RAS dont les ports doivent être énumérés. 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 . Doit être zéro.

[in] hRasConnection

Handle d’une connexion pour laquelle les ports actifs sont énumérés. Si ce paramètre est INVALID_HANDLE_VALUE, tous les ports utilisés ou disponibles pour une utilisation par RRAS sont énumérés. Pour obtenir ce handle, appelez MprAdminConnectionEnum.

[out] lplpbBuffer

Une fois l’exécution réussie, un pointeur vers un tableau de structures RAS_PORT_0 qui décrit le port. Libérez cette mémoire en appelant MprAdminBufferFree.

[in] dwPrefMaxLen

Valeur qui spécifie la longueur maximale préférée des données retournées, en octets de 8 bits. Si ce paramètre est -1, la mémoire tampon retournée est suffisamment grande pour contenir toutes les données disponibles.

[out] lpdwEntriesRead

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

[out] lpdwTotalEntries

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

[in] lpdwResumeHandle

Pointeur vers une variable DWORD . En cas d’exécution réussie, ce paramètre spécifie un handle qui peut être utilisé pour reprendre l’énumération. Ce paramètre doit être égal à zéro lors du premier appel et rester inchangé lors des appels suivants. Si le code de retour est ERROR_MORE_DATA, l’appel peut être réédité avec le handle pour récupérer plus de données. Si le handle a la valeur NULL au retour, l’énumération ne peut pas être poursuivie. 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 répertoriés dans le tableau suivant.

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, peut-être parce que le Gestionnaire d’interface dynamique (DIM) est configuré pour s’exécuter uniquement sur un réseau local.
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 retourné dans le paramètre IpdwResumeHandle .
ERROR_NOT_SUPPORTED
 Le paramètre dwLevel n’est pas égal à zéro.
ERROR_INVALID_HANDLE
 Le paramètre hConnection a la valeur NULL.
Autres
 Erreur de MprError.h, RasError.h ou WinError.h.

Remarques

Si le redistribuable RRAS est installé, cette fonction est disponible sur Windows NT 4.0. Toutefois, la version de Mprapi.dll fournie avec le RRAS redistribuable exporte la fonction en tant que RasAdminPortEnum plutôt que MprAdminPortEnum. 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

Voir aussi

MprAdminBufferFree

MprAdminConnectionEnum

MprAdminServerConnect

Fonctions d’administration RAS

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