Função MprAdminInterfaceConnect (mprapi.h)

Artigo
08/24/2023

A função MprAdminInterfaceConnect cria uma conexão com a interface wan especificada.

Sintaxe

DWORD MprAdminInterfaceConnect(
  [in] MPR_SERVER_HANDLE hMprServer,
  [in] HANDLE            hInterface,
  [in] HANDLE            hEvent,
  [in] BOOL              fSynchronous
);

Parâmetros

[in] hMprServer

Manipule para o roteador no qual executar essa chamada. Obtenha esse identificador chamando MprAdminServerConnect.

[in] hInterface

Manipule para a interface. Esse identificador é obtido de uma chamada anterior para MprAdminInterfaceCreate.

[in] hEvent

Manipule para um evento que é sinalizado após a conclusão da tentativa de conexão da interface. A função inicia a tentativa de conexão e retorna imediatamente. Depois que o evento for sinalizado, você poderá obter o resultado da tentativa de conexão chamando MprAdminInterfaceGetInfo.

Se esse parâmetro for NULL e fBlocking for TRUE, essa chamada será síncrona, ou seja, a função não retornará até que a tentativa de conexão seja concluída.

O aplicativo de chamada deve especificar NULL para esse parâmetro, se hMprServer especificar um roteador remoto.

[in] fSynchronous

Se hEvent for NULL e esse parâmetro for definido como TRUE, a função não retornará até que a tentativa de conexão seja concluída.

Se hEvent for NULL e esse parâmetro for definido como FALSE, a função retornará imediatamente. Um valor retornado de PENDING indica que a tentativa de conexão foi iniciada com êxito.

Se hEvent não for NULL, esse parâmetro será ignorado.

Valor retornado

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
ERROR_ACCESS_DENIED	O aplicativo de chamada não tem privilégios suficientes.
ERROR_ALREADY_CONNECTING	Uma conexão já está em andamento nessa interface.
ERROR_DDM_NOT_RUNNING	O DDM (Gerenciador de Discagem de Demanda) não está em execução.
ERROR_INTERFACE_DISABLED	A interface está desabilitada no momento.
ERROR_INTERFACE_HAS_NO_DEVICES	Nenhum adaptador está disponível para essa interface.
ERROR_INVALID_HANDLE	O valor hInterface é inválido.
ERROR_SERVICE_IS_PAUSED	O serviço de Discagem de Demanda está em pausa no momento.
PENDENTE	A interface está em processo de conexão. O aplicativo de chamada deve aguardar no identificador hEvent , se um tiver sido especificado. Depois que o evento for sinalizado, você poderá obter o estado da conexão e qualquer erro associado chamando MprAdminInterfaceGetInfo.

Comentários

A tabela a seguir resume a relação entre hEvent e fBlocking.

hEvent	fBlocking	Resultado
Identificador de Evento	Ignored	A chamada é retornada imediatamente. Um valor retornado de PENDING indica que a tentativa foi iniciada com êxito. Aguarde o hEvent. Quando hEvent for sinalizado, use MprAdminInterfaceGetInfo para determinar o êxito ou a falha da tentativa de conexão.
NULL	TRUE	A chamada não retorna até que a tentativa de conexão seja concluída.
NULL	FALSE	A chamada é retornada imediatamente. Um valor retornado de PENDING indica que a tentativa foi iniciada com êxito.

Requisitos


Cliente mínimo com suporte	Nenhum compatível
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