Função MultinetGetConnectionPerformanceA (winnetwk.h)

  • Artigo

A função MultinetGetConnectionPerformance retorna informações sobre o desempenho esperado de uma conexão usada para acessar um recurso de rede.

Sintaxe

DWORD MultinetGetConnectionPerformanceA(
  [in]  LPNETRESOURCEA         lpNetResource,
  [out] LPNETCONNECTINFOSTRUCT lpNetConnectInfoStruct
);

Parâmetros

[in] lpNetResource

Um ponteiro para uma estrutura NETRESOURCE que especifica o recurso de rede. Os membros a seguir têm significados específicos nesse contexto.

Membro Significado
Lplocalname
 Um ponteiro para um buffer que especifica um dispositivo local, como "F:" ou "LPT1", que é redirecionado para um recurso de rede a ser consultado.

Se esse membro for NULL ou uma cadeia de caracteres vazia, o recurso de rede será especificado no membro lpRemoteName . Se esse sinalizador especificar um dispositivo local, lpRemoteName será ignorado.
Lpremotename
 Um ponteiro para um recurso de rede a ser consultado. No momento, o recurso deve ter uma conexão estabelecida. Por exemplo, se o recurso for um arquivo em um servidor de arquivos, ter o arquivo aberto garantirá a conexão.
lpProvider
 Normalmente definido como NULL, mas pode ser um ponteiro para o proprietário (provedor) do recurso se a rede na qual o recurso reside for conhecida.

Se o membro lpProvider não for NULL, o sistema tentará retornar informações apenas sobre a rede nomeada.

[out] lpNetConnectInfoStruct

Um ponteiro para a estrutura NETCONNECTINFOSTRUCT que recebe os dados.

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 código de erro do sistema, como um dos valores a seguir.

Código de retorno Descrição
ERROR_NOT_SUPPORTED
 O recurso de rede não fornece essas informações.
ERROR_NOT_CONNECTED
 O membro lpLocalName da estrutura NETRESOURCE apontada pelo parâmetro lpNetResource não especifica um dispositivo redirecionado ou o membro lpRemoteName não especifica o nome de um recurso conectado no momento.
ERROR_NO_NET_OR_BAD_PATH
 A operação não pôde ser concluída, seja porque um componente de rede não foi iniciado ou porque o nome do recurso especificado não é reconhecido.
ERROR_BAD_DEVICE
 O dispositivo local especificado pelo membro lpLocalName é inválido.
ERROR_BAD_NET_NAME
 O nome de rede não foi encontrado. Esse erro será retornado se o membro lpLocalName da estrutura NETRESOURCE apontado pelo parâmetro lpNetResource for NULL e o membro lpRemoteName da estrutura NETRESOURCE apontada pelo lpNetResource também fosse ou NULL ou não pudesse ser reconhecido por qualquer rede.
ERROR_INVALID_ADDRESS
 Uma tentativa de acessar um endereço inválido. Esse erro será retornado se os parâmetros lpNetResource ou lpNetConnectInfoStruct forem NULL.
ERROR_INVALID_PARAMETER
 Um parâmetro inválido foi passado. Esse erro será retornado se o parâmetro lpNetConnectInfoStruct não apontar para uma estrutura NETCONNECTINFOSTRUCT na qual o membro cbStructure é preenchido com o tamanho adequado da estrutura.
ERROR_NO_NETWORK
 A rede não está disponível.
ERROR_EXTENDED_ERROR
 Ocorreu um erro específico da rede. Para obter uma descrição do erro, chame WNetGetLastError.

Comentários

A função MultinetGetConnectionPerformance retorna as informações em uma estrutura NETCONNECTINFOSTRUCT .

As informações retornadas pela função MultinetGetConnectionPerformance são apenas uma estimativa. O tráfego de rede e o roteamento podem afetar a precisão dos resultados retornados.

Observe que a função MultinetGetConnectionPerformance só pode ser usada para solicitar informações para um dispositivo local que é redirecionado para um recurso de rede ou para um recurso de rede ao qual há atualmente uma conexão.

Se um caminho UNC for especificado no membro lpRemoteName da estrutura NETRESOURCE apontada pelo parâmetro lpNetResource , o membro lpRemoteName deverá ser um nome de diretório, não um nome de arquivo.

Uma maneira típica de usar essa função seria abrir um arquivo em um servidor de rede (o que garantiria que haja uma conexão com o arquivo), chamar essa função e usar os resultados para tomar decisões sobre como gerenciar a E/S do arquivo. Por exemplo, você pode decidir se deseja ler o arquivo inteiro em um arquivo temporário no cliente ou acessar diretamente o arquivo no servidor.

Observação

O cabeçalho winnetwk.h define MultinetGetConnectionPerformance como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

Requisitos

   
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 winnetwk.h
Biblioteca Mpr.lib
DLL Mpr.dll

Confira também

NETCONNECTINFOSTRUCT

NETRESOURCE

Visão geral da Rede do Windows (WNet)

Funções de rede do Windows