Função MprAdminConnectionEnum (mprapi.h)
A função MprAdminConnectionEnum enumera todas as conexões ativas.
Sintaxe
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
Manipule para o servidor RAS no qual as conexões são enumeradas. Obtenha esse identificador chamando MprAdminServerConnect.
[in] dwLevel
Um valor DWORD que descreve o formato no qual as informações são retornadas no parâmetro lplpbBuffer . Os valores aceitáveis para dwLevel incluem 0, 1, 2 e 3, conforme listado na tabela a seguir.
Windows NT 4.0: esse parâmetro deve ser zero.
Valor | Formato de estrutura |
---|---|
0 | RAS_CONNECTION_0 |
1 | Windows 2000 ou posterior: RAS_CONNECTION_1 |
2 | Windows 2000 ou posterior: RAS_CONNECTION_2 |
3 | Windows Server 2008 ou posterior: RAS_CONNECTION_3 |
[out] lplpbBuffer
Após a conclusão bem-sucedida, um ponteiro para uma matriz de estruturas que descrevem a conexão. Essas estruturas são do tipo RAS_CONNECTION_0, RAS_CONNECTION_1, RAS_CONNECTION_2 ou RAS_CONNECTION_3, dependendo do valor do parâmetro dwLevel .
Para liberar essa memória, chame MprAdminBufferFree.
[in] dwPrefMaxLen
Especifica o comprimento máximo preferencial dos dados retornados em bytes de 8 bits. Se dwPrefMaxLen for -1, o buffer retornado será grande o suficiente para manter todas as informações disponíveis.
[out] lpdwEntriesRead
Ponteiro para uma variável DWORD . Essa variável recebe o número total de conexões enumeradas da posição de currículo atual.
[out] lpdwTotalEntries
Ponteiro para uma variável DWORD . Essa variável recebe o número total de conexões que poderiam ter sido enumeradas da posição de currículo atual.
[in] lpdwResumeHandle
Ponteiro para uma variável DWORD . Essa variável especifica um identificador de currículo usado para continuar a enumeração. O parâmetro lpdwResumeHandle é zero na primeira chamada e permanece inalterado nas chamadas subsequentes. Se o código de retorno for ERROR_MORE_DATA, outra chamada poderá ser feita usando esse identificador para recuperar mais dados. Se o identificador for NULL no retorno, a enumeração será concluída. Esse identificador é inválido para outros tipos de retorno de erro.
Retornar valor
Se a função for bem-sucedida, o valor retornado será NO_ERROR.
Se a função falhar, o valor retornado será um dos seguintes códigos de erro.
Valor | Significado |
---|---|
|
O DDM (Gerenciador de Discagem de Demanda) não está em execução, possivelmente porque o DIM (Gerenciador de Interface Dinâmica) está configurado para ser executado somente em uma LAN. |
|
O valor passado para dwLevel não é zero, um, dois ou três. Os níveis um e dois têm suporte apenas no Windows 2000 ou posterior. O nível três tem suporte apenas no Windows Server 2008 ou posterior. |
|
Pelo menos um dos seguintes parâmetros é NULL ou não aponta para memória válida: lplpBuffer, lpdwEntriesRead ou lpdwTotalEntries. |
|
Nem todos os dados foram retornados com essa chamada. Para obter dados adicionais, chame a função novamente usando o identificador de retomada. |
|
O identificador passado no parâmetro hRasServer é NULL ou inválido. |
|
Um erro de MprError.h, RasError.h ou WinError.h. |
Comentários
Essa função estará disponível no Windows NT 4.0 se o redistribuível RRAS estiver instalado. No entanto, a versão de Mprapi.dll que é fornecida com o RRAS redistribuível exporta a função como RasAdminConnectionEnum em vez de MprAdminConnectionEnum. Portanto, ao usar o RRAS redistribuível, use LoadLibrary e GetProcAddress para acessar essa função.
Requisitos
Requisito | Valor |
---|---|
Cliente mínimo com suporte | Windows 2000 Professional [somente aplicativos da área de trabalho] |
Servidor mínimo com suporte | Windows 2000 Server [somente aplicativos da área de trabalho] |
Plataforma de Destino | Windows |
Cabeçalho | mprapi.h |
Biblioteca | Mprapi.lib |
DLL | Mprapi.dll |