AssocQueryStringByKeyA-Funktion (shlwapi.h)

  • Artikel

Sucht nach einer Dateizuordnungszeichenfolge aus der Registrierung, die mit einem angegebenen Schlüssel beginnt, und ruft sie ab.

Syntax

LWSTDAPI AssocQueryStringByKeyA(
  [in]            ASSOCF   flags,
  [in]            ASSOCSTR str,
  [in]            HKEY     hkAssoc,
  [in, optional]  LPCSTR   pszExtra,
  [out, optional] LPSTR    pszOut,
  [in, out]       DWORD    *pcchOut
);

Parameter

[in] flags

Typ: ASSOCF

Die Flags, mit denen die Suche gesteuert werden kann. Es kann sich um eine beliebige Kombination von ASSOCF-Werten handeln, mit der Ausnahme, dass nur ein ASSOCF_INIT Wert eingeschlossen werden kann.

[in] str

Typ: ASSOCSTR

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

[in] hkAssoc

Typ: HKEY

Der HKEY-Wert des Schlüssels, der als Stammschlüssel verwendet wird. Die Suche sucht nur unterhalb dieses Schlüssels.

[in, optional] pszExtra

Typ: LPCTSTR

Ein Zeiger auf eine optionale NULL-Zeichenfolge mit zusätzlichen Informationen zum Speicherort der Zeichenfolge. Es ist normalerweise auf ein Shell-Verb wie open festgelegt. Legen Sie diesen Parameter auf NULL fest, wenn er nicht verwendet wird.

[out, optional] pszOut

Typ: LPTSTR

Ein Zeiger auf eine NULL-Zeichenfolge, 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 bei einem Eintrag die Anzahl der Zeichen im pszOut-Puffer angibt. Wenn die Funktion zurückgibt, verweist sie auf die Anzahl der Zeichen, die im Puffer platziert sind.

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

Wenn pszOutNULL 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 puffer pszOut ist zu klein, um die gesamte Zeichenfolge zu speichern.
S_FALSE pszOut ist NULL. pcchOut enthält die erforderliche Puffergröße.

Hinweise

Diese Funktion ist ein Wrapper für die IQueryAssociations-Schnittstelle . Es soll die Verwendung dieser Schnittstelle vereinfachen. Weitere Informationen zur Funktionsweise der Dateizuordnungsfunktionen finden Sie unter IQueryAssociations.

Hinweis

Der shlwapi.h-Header definiert AssocQueryStringByKey als Alias, der automatisch die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit nicht codierungsneutralem Code kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

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 Shlwapi.dll (Version 5.0 oder höher)