IQueryAssociations::GetString-Methode (shlwapi.h)

  • Artikel

Sucht nach einer Datei- oder Protokollzuordnungszeichenfolge und ruft sie aus der Registrierung ab.

Syntax

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

Parameter

[in] flags

Typ: ASSOCF

Ein Flag, das zum Steuern der Suche verwendet werden kann. Es kann sich um eine beliebige Kombination der folgenden ASSOCF-Werte handeln.

[in] str

Typ: ASSOCSTR

Ein ASSOCSTR-Wert , der den Typ der zurückzugebenden Zeichenfolge angibt.

[in, optional] pszExtra

Typ: LPCWSTR

Ein Zeiger auf eine optionale Unicode-Zeichenfolge mit Null-Beendigung mit Informationen zum Speicherort der Zeichenfolge. Es wird in der Regel auf ein Shell-Verb festgelegt, z. B. open. Legen Sie diesen Parameter auf NULL fest, wenn er nicht verwendet wird.

[out, optional] pszOut

Typ: LPWSTR

Ein Zeiger auf eine Unicode-Zeichenfolge mit Null-Endung, die verwendet wird, um die angeforderte Zeichenfolge zurückzugeben. Legen Sie diesen Parameter auf NULL fest, um die erforderliche Puffergröße abzurufen.

[in, out] pcchOut

Typ: DWORD*

Ein Zeiger auf einen Wert, der beim Eintrag auf die Anzahl der Zeichen im pwszOut-Puffer festgelegt ist. Wenn die Funktion erfolgreich zurückgegeben wird, verweist sie auf die Anzahl der Zeichen, die im Puffer platziert sind.

Wenn das ASSOCF_NOTRUNCATE-Flag in Flags festgelegt ist und der in pwszOut angegebene Puffer zu klein ist, gibt die Funktion E_POINTER- und pcchOut-Punkte auf die erforderliche Größe des Puffers zurück.

Wenn pwszOutNULL ist, gibt die Funktion S_FALSE- und pcchOut-Punkte auf die erforderliche Größe des Puffers zurück.

Rückgabewert

Typ: HRESULT

Gibt einen COM-Standardfehlerwert zurück, einschließlich der folgenden:

Fehler Bedeutung
S_OK Erfolg.
E_POINTER Der pwszOut-Puffer ist zu klein, um die gesamte Zeichenfolge aufzunehmen.
S_FALSE pwszOut ist NULL. pcchOut enthält die erforderliche Puffergröße.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows 2000 Professional, Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows 2000 Server [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile shlwapi.h
Bibliothek Shlwapi.lib
DLL Shell32.dll (Version 5.0 oder höher)