Função NPGetPropertyText (npapi.h)

Recupera os nomes dos botões a serem adicionados a uma caixa de diálogo de propriedade para um recurso de rede.

Sintaxe

DWORD NPGetPropertyText(
  [in]      DWORD  iButton,
  [in]      DWORD  nPropSel,
  [in]      LPWSTR lpName,
  [out]     LPWSTR lpButtonName,
  [in, out] DWORD  nButtonNameLen,
  [in]      DWORD  nType
);

Parâmetros

[in] iButton

Indica o índice do botão. O Gerenciador de Arquivos dá suporte a no máximo seis botões. Esse parâmetro será numerado de 1 a 6 para cada um dos botões possíveis se apenas um arquivo estiver selecionado ou 11 a 16 se vários arquivos estiverem selecionados.

[in] nPropSel

Especifica em quais itens a caixa de diálogo de propriedade se concentra. Esse pode ser um dos valores a seguir.

Valor	Significado
WNPS_FILE	Um único arquivo.
WNPS_DIR	Um único diretório.
WNPS_MULT	Uma seleção de vários arquivos, diretórios ou ambos.

[in] lpName

Ponteiro para uma cadeia de caracteres terminada em nulo que contém os nomes do item ou itens a serem exibidos ou editados por meio da caixa de diálogo. Os únicos itens com suporte são arquivos e diretórios, portanto, os nomes dos itens são nomes de arquivo. Elas devem ser inequívocas, não conter caracteres curinga e ser totalmente qualificadas (por exemplo, C:\LOCAL\EXAMPLE.DOC). Vários nomes de arquivo devem ser separados com espaços. Um nome de arquivo que contém espaços pode estar entre aspas (por exemplo, "C:\Meu Arquivo"). Nesse caso. ele é tratado como um único nome. O caractere de cursor '^' também pode ser usado como o mecanismo de aspas para caracteres únicos (por exemplo, C:\My^"File, "C:\My^"File" referem-se ao arquivo C:\My"File).

[out] lpButtonName

Ponteiro para um buffer em que o provedor de rede deve copiar o nome do botão de propriedade. Em caso de êxito, o buffer apontado por lpButtonName contém o nome do botão de propriedade. Se esse buffer, ao sair, contiver a cadeia de caracteres vazia, o botão correspondente a esse nome e todos os botões bem-sucedidos serão removidos da caixa de diálogo. O provedor de rede não pode "ignorar" um botão.

[in, out] nButtonNameLen

Especifica o tamanho do buffer lpButtonName em caracteres, incluindo o caractere nulo de terminação.

[in] nType

Especifica o tipo de item, que deve ser WNTYPE_FILE.

Retornar valor

Se a função for bem-sucedida, ela deverá retornar WN_SUCCESS e lpButtonName poderá ser usado. Se ele apontar para a cadeia de caracteres vazia, nenhum botão corresponderá a um índice tão alto quanto iButton. Se o valor retornado não for WN_SUCCESS, o provedor também deverá chamar SetLastError para definir informações de erro estendidas. Os códigos de erro estendidos incluem o seguinte.

Código de retorno	Descrição
WN_OUT_OF_MEMORY	Não foi possível carregar a cadeia de caracteres dos recursos.
WN_MORE_DATA	O buffer fornecido é muito pequeno para ajustar o texto do botão.
WN_BAD_VALUE	O parâmetro lpName é uma forma inesperada.
WN_NOT_SUPPORTED	Não há suporte para caixas de diálogo de propriedade para o tipo de objeto fornecido, nType.

Comentários

O Gerenciador de Arquivos chama essa função sempre que a caixa de diálogo de propriedade é acionada e faz isso antes de exibir a caixa de diálogo. Se o usuário clicar em um botão adicionado por meio dessa função pelo provedor de rede, a função NPPropertyDialog será chamada com os parâmetros apropriados.

Somente o Gerenciador de Arquivos chama NPGetPropertyText e usa essa função para arquivos e diretórios.

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