Función AssocQueryStringByKeyA (shlwapi.h)

Busca y recupera una cadena relacionada con la asociación de archivos del registro a partir de una clave especificada.

Sintaxis

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

Marcas que se pueden usar para controlar la búsqueda. Puede ser cualquier combinación de valores de ASSOCF, excepto que solo se puede incluir un valor ASSOCF_INIT.

[in] str

Tipo: ASSOCSTR

Valor de ASSOCSTR que especifica el tipo de cadena que se va a devolver.

[in] hkAssoc

Tipo: HKEY de

Valor HKEY de la clave que se usará como clave raíz. La búsqueda solo se ve debajo de esta clave.

[in, optional] pszExtra

Tipo: LPCTSTR de

Puntero a una cadena opcional terminada en NULL con información adicional sobre la ubicación de la cadena. Normalmente se establece en un verbo shell, como abrir. Establezca este parámetro en NULL si no se usa.

[out, optional] pszOut

Tipo: LPTSTR de

Puntero a una cadena terminada en null que se usa para devolver la cadena solicitada. Establezca este parámetro en NULL para recuperar el tamaño de búfer necesario.

[in, out] pcchOut

Tipo: DWORD* de

Puntero a un valor que, en la entrada, especifica el número de caracteres del búfer de pszOut. Cuando se devuelve la función, apunta al número de caracteres colocados en el búfer.

Si la marca ASSOCF_NOTRUNCATE se establece en marcas y el búfer especificado en pszOut es demasiado pequeño, la función devuelve E_POINTER y el valor se establece en el tamaño necesario del búfer.

Si pszOut es NULL, la función devuelve S_FALSE y pcchOut apunta al tamaño necesario del búfer.

Valor devuelto

Tipo: HRESULT

Devuelve un valor de error COM estándar, incluido lo siguiente:

Error	Significado
S_OK	Éxito.
E_POINTER	El búfer pszOut es demasiado pequeño para contener toda la cadena.
S_FALSE	pszOut es NULL . pcchOut contiene el tamaño de búfer necesario.

Observaciones

Esta función es un contenedor para la interfaz IQueryAssociations. Está pensado para simplificar el proceso de uso de esta interfaz. Para obtener más información sobre cómo funcionan las funciones de asociación de archivos, consulte IQueryAssociations.

Nota

El encabezado shlwapi.h define AssocQueryStringByKey como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Conventions for Function Prototypes.

Requisitos

Requisito	Valor
cliente mínimo admitido	Windows 2000 Professional, Windows XP [solo aplicaciones de escritorio]
servidor mínimo admitido	Windows 2000 Server [solo aplicaciones de escritorio]
de la plataforma de destino de	Windows
encabezado de	shlwapi.h
biblioteca de	Shlwapi.lib
DLL de	Shlwapi.dll (versión 5.0 o posterior)