Método IQueryAssociations::GetString (shlwapi.h)

  • Artigo

Pesquisa e recupera uma cadeia de caracteres relacionada à associação de arquivo ou protocolo do registro.

Sintaxe

HRESULT GetString(
  [in]            ASSOCF   flags,
  [in]            ASSOCSTR str,
  [in, optional]  LPCWSTR  pszExtra,
  [out, optional] LPWSTR   pszOut,
  [in, out]       DWORD    *pcchOut
);

Parâmetros

[in] flags

Tipo: ASSOCF

Um sinalizador que pode ser usado para controlar a pesquisa. Pode ser qualquer combinação dos seguintes valores ASSOCF .

[in] str

Tipo: ASSOCSTR

Um valor ASSOCSTR que especifica o tipo de cadeia de caracteres que deve ser retornado.

[in, optional] pszExtra

Tipo: LPCWSTR

Um ponteiro para uma cadeia de caracteres Unicode opcional terminada em nulo com informações sobre o local da cadeia de caracteres. Normalmente, ele é definido como um verbo shell, como aberto. Defina esse parâmetro como NULL se ele não for usado.

[out, optional] pszOut

Tipo: LPWSTR

Um ponteiro para uma cadeia de caracteres Unicode terminada em nulo usada para retornar a cadeia de caracteres solicitada. Defina esse parâmetro como NULL para recuperar o tamanho do buffer necessário.

[in, out] pcchOut

Tipo: DWORD*

Um ponteiro para um valor que, na entrada, é definido como o número de caracteres no buffer pwszOut . Quando a função retorna com êxito, ela aponta para o número de caracteres colocados no buffer.

Se o sinalizador ASSOCF_NOTRUNCATE estiver definido em sinalizadores e o buffer especificado em pwszOut for muito pequeno, a função retornará E_POINTER e pcchOut apontará para o tamanho necessário do buffer.

Se pwszOut for NULL, a função retornará S_FALSE e pcchOut apontará para o tamanho necessário do buffer.

Retornar valor

Tipo: HRESULT

Retorna um valor de erro COM padrão, incluindo o seguinte:

Erro do Significado
S_OK Êxito.
E_POINTER O buffer pwszOut é muito pequeno para conter toda a cadeia de caracteres.
S_FALSE pwszOut é NULL. pcchOut contém o tamanho do buffer necessário.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows 2000 Professional, Windows XP [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 shlwapi.h
Biblioteca Shlwapi.lib
DLL Shell32.dll (versão 5.0 ou posterior)