Função MprAdminTransportGetInfo (mprapi.h)

Artigo
03/13/2024

A função MprAdminTransportGetInfo recupera informações globais, informações de interface do cliente padrão ou ambas, para um transporte especificado.

Sintaxe

DWORD MprAdminTransportGetInfo(
  [in]            MPR_SERVER_HANDLE hMprServer,
  [in]            DWORD             dwTransportId,
  [out, optional] LPBYTE            *ppGlobalInfo,
  [out, optional] LPDWORD           lpdwGlobalInfoSize,
  [out, optional] LPBYTE            *ppClientInterfaceInfo,
  [out, optional] LPDWORD           lpdwClientInterfaceInfoSize
);

Parâmetros

[in] hMprServer

Identificador para o roteador do qual as informações estão sendo recuperadas. Esse identificador é obtido de uma chamada anterior para MprAdminServerConnect.

[in] dwTransportId

Um valor DWORD que descreve o tipo de transporte a ser recuperado. Os valores aceitáveis para dwTransportId estão listados na tabela a seguir.

Valor	Transporte (Família de Protocolos)
PID_ATALK	Appletalk
PID_IP	Protocolo internet versão 4
PID_IPX	Troca de Pacotes da Internet
PID_NBF	Protocolo NetBIOS Frames
PID_IPV6	Windows Server 2008 ou posterior: Protocolo de Internet versão 6

[out, optional] ppGlobalInfo

Ponteiro para uma variável de ponteiro. Essa variável aponta para um cabeçalho de informações que recebe informações globais para esse transporte. Use as Funções de Cabeçalho de Informações para manipular cabeçalhos de informações.

Libere essa memória chamando MprAdminBufferFree.

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, das informações globais do transporte.

[out, optional] ppClientInterfaceInfo

Ponteiro para uma variável de ponteiro. Essa variável aponta para informações padrão da interface do cliente para esse transporte. Libere essa memória chamando MprAdminBufferFree.

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 do cliente.

[out, optional] lpdwClientInterfaceInfoSize

Ponteiro para uma variável DWORD . Essa variável recebe o tamanho, em bytes, das informações da interface do cliente.

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

Valor	Significado
ERROR_ACCESS_DENIED	O aplicativo de chamada não tem privilégios suficientes.
ERROR_INVALID_PARAMETER	Uma das seguintes condições é verdadeira: O parâmetro ppGlobalInfo e o parâmetro ppClientInterfaceInfo são NULL. O parâmetro ppGlobalInfo não aponta para a memória válida. O parâmetro ppClientInterfaceInfo não aponta para memória válida.
ERROR_NOT_ENOUGH_MEMORY	Recursos insuficientes para concluir a operação.
ERROR_UNKNOWN_PROTOCOL_ID	O valor dwTransportId não corresponde a nenhum transporte instalado.

Comentários

Os parâmetros ppGlobalInfo e ppClientInterfaceInfo não podem ser NULL.

Requisitos

Requisito	Valor
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