Função MprConfigInterfaceTransportGetInfo (mprapi.h)

Artigo
03/15/2023

A função MprConfigInterfaceTransportGetInfo recupera as informações de configuração do cliente especificado na interface especificada.

Sintaxe

DWORD MprConfigInterfaceTransportGetInfo(
  [in]                HANDLE  hMprConfig,
  [in]                HANDLE  hRouterInterface,
  [in]                HANDLE  hRouterIfTransport,
  [in, out, optional] LPBYTE  *ppInterfaceInfo,
  [out, optional]     LPDWORD lpdwInterfaceInfoSize
);

Parâmetros

[in] hMprConfig

Manipule para a configuração do roteador. Obtenha esse identificador chamando MprConfigServerConnect.

[in] hRouterInterface

Manipule para a configuração de interface da qual recuperar as informações do cliente especificadas. Obtenha esse identificador chamando MprConfigInterfaceCreate, MprConfigInterfaceGetHandle ou MprConfigInterfaceEnum.

[in] hRouterIfTransport

Manipule para a configuração de transporte da qual recuperar as informações do cliente especificadas. Obtenha esse identificador chamando MprConfigInterfaceTransportAdd, MprConfigInterfaceTransportGetHandle ou MprConfigInterfaceTransportEnum. Os tipos de protocolo de transporte com suporte são listados em Identificadores de Transporte.

[in, out, optional] ppInterfaceInfo

Na entrada, ponteiro para uma variável de ponteiro.

Na saída, essa variável de ponteiro aponta para um cabeçalho de informações que contém informações de configuração para o cliente. Use as Funções de Cabeçalho de Informações para manipular cabeçalhos de informações. Libere essa memória chamando MprConfigBufferFree.

Esse parâmetro é opcional. Se o aplicativo de chamada especificar NULL para esse parâmetro, a função não retornará as informações de configuração.

[out, optional] lpdwInterfaceInfoSize

Ponteiro para uma variável DWORD . Essa variável recebe o tamanho, em bytes, dos dados apontados por ppInterfaceInfo.

Esse parâmetro é opcional; o aplicativo de chamada pode especificar NULL para esse parâmetro. No entanto, se ppInterfaceInfo não for NULL, esse parâmetro não poderá ser NULL. Para obter mais informações, consulte a seção Comentários, mais adiante neste tópico.

Valor retornado

Se a função for bem-sucedida, o valor retornado será NO_ERROR. Para obter mais informações, consulte a seção Comentários, mais adiante neste tópico.

Se a função falhar, o valor retornado será um dos seguintes códigos de erro.

Valor	Significado
ERROR_INVALID_PARAMETER	Uma das seguintes condições é verdadeira: hMprConfig é NULL. hRouterInterface é NULL. hRouterIfTransport é NULL. ppInterfaceInfo não é NULL, mas lpdwInterfaceInfoSize é NULL.
ERROR_NO_SUCH_INTERFACE	A interface especificada por hRouterIfTransport não foi encontrada na configuração do roteador ou o transporte especificado por hRouterIfTransport não foi habilitado na interface especificada.
ERROR_NOT_ENOUGH_MEMORY	Recursos insuficientes para concluir a operação.
Outros	Use FormatMessage para recuperar a mensagem de erro do sistema que corresponde ao código de erro retornado.

Comentários

Se o parâmetro ppInterfaceInfo for NULL, MprConfigInterfaceTransportGetInfo não fará nada e retornará imediatamente com um valor de NO_ERROR.

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