Função NPFormatNetworkName (npapi.h)

  • Artigo

Formata um nome de rede em um formato específico do provedor para exibição em um controle.

Sintaxe

DWORD NPFormatNetworkName(
  [in]      LPWSTR  lpRemoteName,
  [out]     LPWSTR  lpFormattedName,
  [in, out] LPDWORD lpnLength,
  [in]      DWORD   dwFlags,
  [in]      DWORD   dwAveCharPerLine
);

Parâmetros

[in] lpRemoteName

Ponteiro para o nome da rede a ser formatado.

[out] lpFormattedName

Ponteiro para uma cadeia de caracteres que recebe o nome formatado.

[in, out] lpnLength

Ponteiro para DWORD que especifica o tamanho, em caracteres, do buffer lpFormattedName . Se o valor retornado dessa função for WN_MORE_DATA, lpnLength conterá o tamanho do buffer necessário, em caracteres.

[in] dwFlags

Bitfield que indica o tipo de formato que está sendo solicitado. Esse parâmetro pode usar um dos valores a seguir.

Valor Significado
WNFMT_MULTILINE
 O provedor deve colocar a barra invertida n (\\n) em que as quebras de linha devem aparecer no nome. O nome completo deve ser expresso.
WNFMT_ABBREVIATED
 O provedor deve reduzir o nome da rede para que as informações mais úteis para o usuário se encaixem no espaço disponível.
 

Além disso, o sinalizador a seguir, que atua como um modificador para os sinalizadores anteriores, pode ser incluído usando uma operação OR bit a bit.

Valor Significado
WNFMT_INENUM
 O nome da rede é apresentado no contexto de uma enumeração em que o nome do "contêiner" aparece imediatamente antes do nome da rede na enumeração. Isso permite que os provedores de rede removam informações redundantes do nome formatado, fornecendo uma exibição menos desordenada para o usuário.

[in] dwAveCharPerLine

Especifica o número médio de caracteres que caberá em uma única linha em que o nome da rede está sendo apresentado. Especificamente, esse valor é definido como a largura do controle dividido pelo campo tmAveCharWidth da estrutura TEXTMETRIC da fonte usada para exibição no controle .

Retornar valor

Se a função for bem-sucedida, ela deverá retornar WN_SUCCESS.

Se a função falhar, ela deverá retornar o valor a seguir. Todos os outros erros serão ignorados e o nome da rede não formatado será usado.

Código de retorno Descrição
WN_MORE_DATA
 O buffer de entrada é muito pequeno.

Comentários

Essa função permite que os fornecedores de rede cortem ou modifiquem nomes de rede antes de serem apresentados ao usuário. Por exemplo, na caixa de diálogo Abrir comum, a caixa de combinação Unidades apresenta todos os recursos conectados e seu nome de rede associado. Antes de cada item ser exibido, NPFormatNetworkName é chamado e o provedor de rede tem a opção de editar o nome para que ele se ajuste na caixa de combinação. Mais importante, o provedor de rede pode editar o nome para apresentar a parte mais significativa do nome de rede ao usuário.

Observe que NPFormatNetworkName não é roteado para cada provedor de rede, como a maioria das outras funções do provedor de rede. Cada fornecedor de rede precisa se preocupar apenas com a formatação de seu próprio nome de rede. Eles podem supor que apenas os nomes produzidos pelo driver do provedor de rede serão passados para NPFormatNetworkName.

Os sinalizadores WNFMT_ normalmente são passados em vários locais na interface do usuário, conforme descrito na tabela a seguir. Nenhuma suposição deve ser feita sobre quais sinalizadores são passados para onde; essa tabela é fornecida exclusivamente para ajudar cada fornecedor de rede a decidir o melhor método para modificar seu nome de rede.

Exibir localização WNFMT_ MULTILINE WNFMT_ ABREVIADO WNFMT_ INENUM
Caixa de diálogo Conexão do Gerenciador de Arquivos, Caixa de combinação unidade, seleção. (A seção de seleção da caixa de combinação é o retângulo superior, acima da seção de lista, que exibe a seleção atual.)   X  
Caixa de diálogo Conexão do Gerenciador de Arquivos, caixa de combinação Unidade, lista. (A seção de lista da caixa de combinação é a caixa de listagem que aparece abaixo da parte de seleção da caixa de combinação.) X    
Gerenciador de Arquivos, Lista de Diretórios Compartilhados .   X X
Lista Desconectar Unidade de Rede do Gerenciador de Arquivos. X    
Gerenciador de Arquivos, barra de ferramentas, caixa de combinação, seleção.   X  
Gerenciador de Arquivos, barra de ferramentas, caixa de combinação, lista. X    
Caixas de diálogo Abrir e Salvar Comuns, Caixa de combinação unidade , seleção.   X  
Caixas de diálogo Abrir e Salvar Comuns, Caixa de combinação Unidade , lista.   X  

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows XP [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho npapi.h