Função NPFormatNetworkName (npapi.h)

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 ser um dos valores a seguir.

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.

[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.

Valor de retorno

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.

Observações

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 para o usuário.

Observe que NPFormatNetworkName não é roteado para cada provedor de rede, como a maioria das outras funções de provedor de rede. Cada fornecedor de rede precisa se preocupar apenas com a formatação de seu próprio nome de rede. Eles podem assumir que somente 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; esta tabela é fornecida exclusivamente para ajudar cada fornecedor de rede a decidir o melhor método para modificar o nome da rede.

Requirements