AssocQueryStringByKeyA-Funktion (shlwapi.h)

Artikel
11/20/2024

Sucht nach einer dateizuordnungsbezogenen Zeichenfolge aus der Registrierung ab einem angegebenen Schlüssel 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, die zum Steuern der Suche verwendet werden können. Es kann sich um eine beliebige Kombination aus 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 sieht nur unter diesem Schlüssel aus.

[in, optional] pszExtra

Typ: LPCTSTR-

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

[out, optional] pszOut

Typ: LPTSTR-

Ein Zeiger auf eine mit Null beendete Zeichenfolge, die zum Zurückgeben der angeforderten Zeichenfolge verwendet wird. 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 die Anzahl der Zeichen im pszOut- Puffer angibt. Wenn die Funktion zurückgegeben wird, verweist sie auf die Anzahl der Zeichen, die im Puffer platziert werden.

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 pszOut-NULL-ist, gibt die Funktion S_FALSE zurück, und pcchOut verweist auf die erforderliche Größe des Puffers.

Rückgabewert

Typ: HRESULT-

Gibt einen standardmäßigen COM-Fehlerwert zurück, einschließlich der folgenden:

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

Bemerkungen

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

Anmerkung

Der Header "shlwapi.h" definiert AssocQueryStringByKey als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht codierungsneutral ist, 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
mindestens unterstützte Client-	Windows 2000 Professional, Windows XP [nur Desktop-Apps]
mindestens unterstützte Server-	Windows 2000 Server [nur Desktop-Apps]
Zielplattform-	Fenster
Header-	shlwapi.h
Library	Shlwapi.lib
DLL-	Shlwapi.dll (Version 5.0 oder höher)

Freigeben über