Función MprAdminConnectionEnumEx (mprapi.h)
La función MprAdminConnectionEnumEx enumera las conexiones activas para un servidor RRAS especificado.
Sintaxis
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
);
Parámetros
[in] hRasServer
Identificador del servidor RAS en el que se enumeran las conexiones. Obtenga este identificador llamando a MprAdminServerConnect.
[in] pObjectHeader
Puntero a una estructura de MPRAPI_OBJECT_HEADER que especifica la versión de estructura recibida por ppRasConn.
[in] dwPreferedMaxLen
Valor que 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 un DWORD que recibe el número total de conexiones enumeradas a partir de la posición de reanudación actual.
[out] lpdwTotalEntries
Puntero a un DWORD que recibe el número total de conexiones que se podrían haber enumerado a partir de la posición de reanudación actual.
[out] ppRasConn
Puntero, en la salida, a una matriz de estructuras de RAS_CONNECTION_EX que contienen la información de conexión activa para el servidor RRAS en hRasServer. El número de elementos de matriz viene determinado por el valor al que apunta lpdwEntriesRead.
[in] lpdwResumeHandle
Puntero a una variable DWORD que especifica un identificador de reanudación usado para continuar con la enumeración. El parámetro lpdwResumeHandle es NULL 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 |
---|---|
|
La aplicación que realiza la llamada no tiene privilegios suficientes. |
|
El Administrador de marcado a petición (DDM) no se está ejecutando. |
|
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. |
|
No se encontró el procedimiento especificado. |
|
Error de MprError.h, RasError.h o WinError.h. |
Comentarios
El autor de la llamada debe liberar la memoria a la que apunta ppRasConn llamando a la función MprAdminBufferFree.
Requisitos
Requisito | Value |
---|---|
Cliente mínimo compatible | Windows 7 [solo aplicaciones de escritorio] |
Servidor mínimo compatible | Windows Server 2008 R2 [solo aplicaciones de escritorio] |
Plataforma de destino | Windows |
Encabezado | mprapi.h |
Library | Mprapi.lib |
Archivo DLL | Mprapi.dll |