IQueryAssociations ::GetString, méthode (shlwapi.h)

  • Article

Recherche et récupère une chaîne liée à l’association de fichier ou de protocole à partir du Registre.

Syntaxe

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

Paramètres

[in] flags

Type : ASSOCF

Indicateur qui peut être utilisé pour contrôler la recherche. Il peut s’agir de n’importe quelle combinaison des valeurs ASSOCF suivantes.

[in] str

Type : ASSOCSTR

Valeur ASSOCSTR qui spécifie le type de chaîne à retourner.

[in, optional] pszExtra

Type : LPCWSTR

Pointeur vers une chaîne Unicode facultative terminée par null avec des informations sur l’emplacement de la chaîne. Il est généralement 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 : LPWSTR

Pointeur vers une chaîne Unicode terminée par null utilisée pour retourner 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, est définie sur le nombre de caractères dans la mémoire tampon pwszOut . Lorsque la fonction retourne correctement, elle pointe vers le nombre de caractères placés dans la mémoire tampon.

Si l’indicateur ASSOCF_NOTRUNCATE est défini en indicateurs et que la mémoire tampon spécifiée dans pwszOut est trop petite, la fonction retourne E_POINTER et pcchOut pointe vers la taille requise de la mémoire tampon.

Si pwszOut 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 pwszOut est trop petite pour contenir la chaîne entière.
S_FALSE pwszOut a la valeur NULL. pcchOut contient la taille de mémoire tampon requise.

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 Shell32.dll (version 5.0 ou ultérieure)