Função AssocQueryStringByKeyA (shlwapi.h)

Pesquisa e recupera uma cadeia de caracteres relacionada à associação de arquivo do registro a partir de uma chave especificada.

Sintaxe

LWSTDAPI AssocQueryStringByKeyA(
  [in]            ASSOCF   flags,
  [in]            ASSOCSTR str,
  [in]            HKEY     hkAssoc,
  [in, optional]  LPCSTR   pszExtra,
  [out, optional] LPSTR    pszOut,
  [in, out]       DWORD    *pcchOut
);

Parâmetros

[in] flags

Tipo: ASSOCF

Os sinalizadores que podem ser usados para controlar a pesquisa. Pode ser qualquer combinação de valores ASSOCF , exceto que apenas um valor ASSOCF_INIT pode ser incluído.

[in] str

Tipo: ASSOCSTR

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

[in] hkAssoc

Tipo: HKEY

O valor HKEY da chave que será usada como uma chave raiz. A pesquisa só fica abaixo dessa chave.

[in, optional] pszExtra

Tipo: LPCTSTR

Um ponteiro para uma cadeia de caracteres terminada em nulo opcional com informações adicionais 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: LPTSTR

Um ponteiro para uma cadeia de caracteres 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, especifica o número de caracteres no buffer pszOut . Quando a função retorna, ela aponta para o número de caracteres colocados no buffer.

Se o sinalizador ASSOCF_NOTRUNCATE for definido em sinalizadores e o buffer especificado em pszOut for muito pequeno, a função retornará E_POINTER e o valor será definido como o tamanho necessário do buffer.

Se pszOut 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 pszOut é muito pequeno para conter toda a cadeia de caracteres.
S_FALSE	pszOut é NULL. pcchOut contém o tamanho do buffer necessário.

Comentários

Essa função é um wrapper para a interface IQueryAssociations . Ele se destina a simplificar o processo de uso dessa interface. Para obter mais discussões sobre como as funções de associação de arquivo funcionam, consulte IQueryAssociations.

Observação

O cabeçalho shlwapi.h define AssocQueryStringByKey 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

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	Shlwapi.dll (versão 5.0 ou posterior)