Metodo IQueryAssociations::GetString (shlwapi.h)

  • Articolo

Cerca e recupera una stringa correlata all'associazione di file o protocollo dal Registro di sistema.

Sintassi

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

Parametri

[in] flags

Tipo: ASSOCF

Flag che può essere utilizzato per controllare la ricerca. Può essere una qualsiasi combinazione dei valori ASSOCF seguenti.

[in] str

Tipo: ASSOCSTR

Valore ASSOCSTR che specifica il tipo di stringa da restituire.

[in, optional] pszExtra

Tipo: LPCWSTR

Puntatore a una stringa Unicode con terminazione Null facoltativa con informazioni sulla posizione della stringa. In genere è impostato su un verbo shell, ad esempio aperto. Impostare questo parametro su NULL se non viene usato.

[out, optional] pszOut

Tipo: LPWSTR

Puntatore a una stringa Unicode con terminazione Null usata per restituire la stringa richiesta. Impostare questo parametro su NULL per recuperare le dimensioni del buffer necessarie.

[in, out] pcchOut

Tipo: DWORD*

Puntatore a un valore che, nella voce, viene impostato sul numero di caratteri nel buffer pwszOut . Quando la funzione viene restituita correttamente, punta al numero di caratteri inseriti nel buffer.

Se il flag ASSOCF_NOTRUNCATE è impostato nei flag e il buffer specificato in pwszOut è troppo piccolo, la funzione restituisce E_POINTER e pcchOut punta alle dimensioni necessarie del buffer.

Se pwszOut è NULL, la funzione restituisce S_FALSE e pcchOut punta alle dimensioni necessarie del buffer.

Valore restituito

Tipo: HRESULT

Restituisce un valore di errore COM standard, incluso quanto segue:

Errore Significato
S_OK Operazione completata.
E_POINTER Il buffer pwszOut è troppo piccolo per contenere l'intera stringa.
S_FALSE pwszOut è NULL. pcchOut contiene le dimensioni del buffer necessarie.

Requisiti

Requisito Valore
Client minimo supportato Windows 2000 Professional, Windows XP [solo app desktop]
Server minimo supportato Windows 2000 Server [solo app desktop]
Piattaforma di destinazione Windows
Intestazione shlwapi.h
Libreria Shlwapi.lib
DLL Shell32.dll (versione 5.0 o successiva)