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

Busca y recupera una cadena relacionada con la asociación de archivos o protocolos del registro.

Sintaxis

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

Marca que se puede usar para controlar la búsqueda. Puede ser cualquier combinación de los siguientes valores ASSOCF .

[in] str

Tipo: ASSOCSTR

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

[in, optional] pszExtra

Tipo: LPCWSTR

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

[out, optional] pszOut

Tipo: LPWSTR

Puntero a una cadena Unicode 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*

Un puntero a un valor que, en la entrada, se establece en el número de caracteres del búfer pwszOut . Cuando la función vuelve correctamente, 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 pwszOut es demasiado pequeño, la función devuelve E_POINTER y pcchOut apunta al tamaño necesario del búfer.

Si pwszOut 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 Correcto.
E_POINTER El búfer pwszOut es demasiado pequeño para contener toda la cadena.
S_FALSE pwszOut es NULL. pcchOut contiene el tamaño de búfer necesario.

Requisitos

Requisito Value
Cliente mínimo compatible Windows 2000 Professional, Windows XP [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado shlwapi.h
Library Shlwapi.lib
Archivo DLL Shell32.dll (versión 5.0 o posterior)