Função MprConfigTransportGetInfo (mprapi.h)

Artigo
03/15/2023

A função MprConfigTransportGetInfo recupera a configuração do protocolo de transporte especificado do roteador.

Sintaxe

DWORD MprConfigTransportGetInfo(
  [in]                HANDLE  hMprConfig,
  [in]                HANDLE  hRouterTransport,
  [in, out, optional] LPBYTE  *ppGlobalInfo,
  [out, optional]     LPDWORD lpdwGlobalInfoSize,
  [in, out, optional] LPBYTE  *ppClientInterfaceInfo,
  [out, optional]     LPDWORD lpdwClientInterfaceInfoSize,
  [in, out, optional] LPWSTR  *lplpwsDLLPath
);

Parâmetros

[in] hMprConfig

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

[in] hRouterTransport

Identificador para a configuração do protocolo de transporte que está sendo recuperada. Obtenha esse identificador chamando MprConfigTransportCreate, MprConfigTransportGetHandle ou MprConfigTransportEnum. Os tipos de protocolo de transporte com suporte são listados em Identificadores de Transporte.

[in, out, optional] ppGlobalInfo

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 globais para o transporte. Use as Funções de Cabeçalho de Informações para manipular cabeçalhos de informações. Libere esse buffer chamando MprConfigBufferFree.

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

[out, optional] lpdwGlobalInfoSize

Ponteiro para uma variável DWORD . Essa variável recebe o tamanho, em bytes, do buffer retornado por meio do parâmetro ppGlobalInfo .

Esse parâmetro é opcional; o aplicativo de chamada pode especificar NULL para esse parâmetro. No entanto, se ppGlobalInfo não for NULL, esse parâmetro não poderá ser NULL.

[in, out, optional] ppClientInterfaceInfo

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

Na saída, esse ponteiro aponta para um cabeçalho de informações que contém informações de interface padrão para roteadores cliente para esse transporte. Use as Funções de Cabeçalho de Informações para manipular cabeçalhos de informações. Libere o buffer chamando MprConfigBufferFree.

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

[out, optional] lpdwClientInterfaceInfoSize

Ponteiro para uma variável DWORD . Essa variável recebe o tamanho, em bytes, do buffer retornado por meio do parâmetro ppClientInterfaceInfo .

Esse parâmetro é opcional; o aplicativo de chamada pode especificar NULL para esse parâmetro. No entanto, se ppClientInterfaceInfo não for NULL, esse parâmetro não poderá ser NULL.

[in, out, optional] lplpwsDLLPath

Na entrada, ponteiro para um ponteiro para uma cadeia de caracteres Unicode terminada em nulo.

Na saída, a cadeia de caracteres Unicode recebe o nome da DLL do gerenciador de roteador para o transporte especificado.

Esse parâmetro é opcional. Se o aplicativo de chamada especificar NULL para esse parâmetro, a função não recuperará o nome da DLL do gerenciador de roteadores.

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 códigos de erro a seguir.

Valor	Significado
ERROR_INVALID_PARAMETER	Pelo menos um dos seguintes é verdadeiro: hMprConfig é NULL hRouterTransport é NULL ppGlobalInfo não é NULL, mas lpdwGlobalInfoSize é NULL. ppClientInterfaceInfo não é NULL, mas lpdwClientInterfaceInfo é NULL.
ERROR_UNKNOWN_PROTOCOL_ID	A configuração do protocolo de transporte que corresponde a hRouterTransport não foi encontrada na configuração do roteador.
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 os parâmetros pGlobalInfo, pClientInterfaceInfo e lpwsDLLPath forem nulos, a função não fará nada e retornará 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