Função AssocQueryStringByKeyA (shlwapi.h)

Artigo
11/20/2024

Pesquisa e recupera uma cadeia de caracteres relacionada à associação de arquivos 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 de 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 a 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 abrir. Defina esse parâmetro para 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 para 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 aponta para o tamanho necessário do buffer.

Valor de retorno

Tipo: HRESULT

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

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

Observações

Essa função é um wrapper para a interface de 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 arquivos funcionam, consulte IQueryAssociations.

Nota

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 do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows 2000 Professional, Windows XP [somente aplicativos da área de trabalho]
servidor com suporte mínimo	Windows 2000 Server [somente aplicativos da área de trabalho]
da Plataforma de Destino	Windows
cabeçalho	shlwapi.h
biblioteca	Shlwapi.lib
de DLL	Shlwapi.dll (versão 5.0 ou posterior)

Compartilhar via