Función MprAdminConnectionEnum (mprapi.h)

Artículo
03/15/2023

La función MprAdminConnectionEnum enumera todas las conexiones activas.

Sintaxis

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
);

Parámetros

[in] hRasServer

Controle al servidor RAS en el que se enumeran las conexiones. Obtenga este identificador llamando a MprAdminServerConnect.

[in] dwLevel

Valor DWORD que describe el formato en el que se devuelve la información en el parámetro lplpbBuffer . Los valores aceptables para dwLevel incluyen 0, 1, 2 y 3, como se muestra en la tabla siguiente.

Windows NT 4.0: Este parámetro debe ser cero.

Valor	Formato de estructura
0	RAS_CONNECTION_0
1	Windows 2000 o posterior: RAS_CONNECTION_1
2	Windows 2000 o posterior: RAS_CONNECTION_2
3	Windows Server 2008 o posterior: RAS_CONNECTION_3

[out] lplpbBuffer

Al finalizar correctamente, un puntero a una matriz de estructuras que describen la conexión. Estas estructuras son de tipo RAS_CONNECTION_0, RAS_CONNECTION_1, RAS_CONNECTION_2 o RAS_CONNECTION_3, según el valor del parámetro dwLevel .

Para liberar esta memoria, llame a MprAdminBufferFree.

[in] dwPrefMaxLen

Especifica la longitud máxima preferida de los datos devueltos en bytes de 8 bits. Si dwPrefMaxLen es -1, el búfer devuelto es lo suficientemente grande como para contener toda la información disponible.

[out] lpdwEntriesRead

Puntero a una variable DWORD . Esta variable recibe el número total de conexiones enumeradas a partir de la posición de reanudación actual.

[out] lpdwTotalEntries

Puntero a una variable DWORD . Esta variable recibe el número total de conexiones que se podrían haber enumerado a partir de la posición de reanudación actual.

[in] lpdwResumeHandle

Puntero a una variable DWORD . Esta variable especifica un identificador de reanudación usado para continuar con la enumeración. El parámetro lpdwResumeHandle es cero en la primera llamada y se deja sin cambios en las llamadas posteriores. Si el código de retorno es ERROR_MORE_DATA, se puede realizar otra llamada mediante este identificador para recuperar más datos. Si el identificador es NULL al devolverlo, la enumeración se completa. Este identificador no es válido para otros tipos de devoluciones de error.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es NO_ERROR.

Si se produce un error en la función, el valor devuelto es uno de los siguientes códigos de error.

Valor	Significado
ERROR_DDM_NOT_RUNNING	El Administrador de marcado a petición (DDM) no se está ejecutando, posiblemente porque el Administrador de interfaces dinámicas (DIM) está configurado para ejecutarse solo en una LAN.
ERROR_INVALID_LEVEL	El valor pasado para dwLevel no es cero, uno, dos o tres. Los niveles uno y dos solo se admiten en Windows 2000 o posterior. El nivel tres solo se admite en Windows Server 2008 o posterior.
ERROR_INVALID_PARAMETER	Al menos uno de los parámetros siguientes es NULL o no apunta a una memoria válida: lplpBuffer, lpdwEntriesRead o lpdwTotalEntries.
ERROR_MORE_DATA	No todos los datos se devolvieron con esta llamada. Para obtener datos adicionales, llame a la función de nuevo mediante el identificador de reanudación.
RPC_S_INVALID_BINDING	El identificador pasado en el parámetro hRasServer es NULL o no es válido.
Otros	Error de MprError.h, RasError.h o WinError.h.

Comentarios

Esta función está disponible en Windows NT 4.0 si está instalado el redistribuible RRAS. Sin embargo, la versión de Mprapi.dll que se incluye con el redistribuible RRAS exporta la función como RasAdminConnectionEnum en lugar de MprAdminConnectionEnum. Por lo tanto, al usar el redistribuible RRAS, use LoadLibrary y GetProcAddress para acceder a esta función.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	mprapi.h
Library	Mprapi.lib
Archivo DLL	Mprapi.dll