AssocQueryStringByKeyW, fonction (shlwapi.h)
Recherche et récupère une chaîne liée à l’association de fichiers à partir du Registre à partir d’une clé spécifiée.
Syntaxe
LWSTDAPI AssocQueryStringByKeyW(
[in] ASSOCF flags,
[in] ASSOCSTR str,
[in] HKEY hkAssoc,
[in, optional] LPCWSTR pszExtra,
[out, optional] LPWSTR pszOut,
[in, out] DWORD *pcchOut
);
Paramètres
[in] flags
Type : ASSOCF
Indicateurs qui peuvent être utilisés pour contrôler la recherche. Il peut s’agir de n’importe quelle combinaison de valeurs ASSOCF , sauf qu’une seule valeur ASSOCF_INIT peut être incluse.
[in] str
Type : ASSOCSTR
Valeur ASSOCSTR qui spécifie le type de chaîne à retourner.
[in] hkAssoc
Type : HKEY
Valeur HKEY de la clé qui sera utilisée comme clé racine. La recherche se présente uniquement en dessous de cette clé.
[in, optional] pszExtra
Type : LPCTSTR
Pointeur vers une chaîne null facultative avec des informations supplémentaires sur l’emplacement de la chaîne. Il est normalement défini sur un verbe Shell tel que open. Définissez ce paramètre sur NULL s’il n’est pas utilisé.
[out, optional] pszOut
Type : LPTSTR
Pointeur vers une chaîne terminée par null utilisée pour renvoyer la chaîne demandée. Définissez ce paramètre sur NULL pour récupérer la taille de mémoire tampon requise.
[in, out] pcchOut
Type : DWORD*
Pointeur vers une valeur qui, lors de l’entrée, spécifie le nombre de caractères dans la mémoire tampon pszOut . Lorsque la fonction retourne, elle pointe vers le nombre de caractères placés dans la mémoire tampon.
Si l’indicateur ASSOCF_NOTRUNCATE est défini dans des indicateurs et que la mémoire tampon spécifiée dans pszOut est trop petite, la fonction retourne E_POINTER et la valeur est définie sur la taille requise de la mémoire tampon.
Si pszOut a la valeur NULL, la fonction retourne S_FALSE et pcchOut pointe vers la taille requise de la mémoire tampon.
Valeur retournée
Type : HRESULT
Retourne une valeur d’erreur COM standard, y compris les éléments suivants :
Error | Signification |
---|---|
S_OK | Réussite. |
E_POINTER | La mémoire tampon pszOut est trop petite pour contenir la chaîne entière. |
S_FALSE | pszOut a la valeur NULL. pcchOut contient la taille de mémoire tampon requise. |
Remarques
Cette fonction est un wrapper pour l’interface IQueryAssociations . Il est destiné à simplifier le processus d’utilisation de cette interface. Pour plus d’informations sur le fonctionnement de l’association de fichiers, consultez IQueryAssociations.
Notes
L’en-tête shlwapi.h définit AssocQueryStringByKey comme un alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.
Configuration requise
Condition requise | Valeur |
---|---|
Client minimal pris en charge | Windows 2000 Professionnel, Windows XP [applications de bureau uniquement] |
Serveur minimal pris en charge | Windows 2000 Server [applications de bureau uniquement] |
Plateforme cible | Windows |
En-tête | shlwapi.h |
Bibliothèque | Shlwapi.lib |
DLL | Shlwapi.dll (version 5.0 ou ultérieure) |