Méthode IMFAttributes ::GetAllocatedString (mfobjects.h)

  • Article

Obtient une chaîne de caractères larges associée à une clé. Cette méthode alloue la mémoire pour la chaîne.

Syntaxe

HRESULT GetAllocatedString(
  [in]  REFGUID guidKey,
  [out] LPWSTR  *ppwszValue,
  [out] UINT32  *pcchLength
);

Paramètres

[in] guidKey

GUID qui identifie la valeur à récupérer. Le type d’attribut doit être MF_ATTRIBUTE_STRING.

[out] ppwszValue

Si la clé est trouvée et que la valeur est un type de chaîne, ce paramètre reçoit une copie de la chaîne. L’appelant doit libérer la mémoire de la chaîne en appelant CoTaskMemFree.

[out] pcchLength

Reçoit le nombre de caractères dans la chaîne, à l’exclusion du caractère NULL de fin. Ce paramètre ne doit pas avoir la valeur NULL.

Valeur retournée

Cette méthode retourne un code HRESULT. Les valeurs possibles sont notamment celles figurant dans le tableau suivant.

Code de retour Description
S_OK
 S_OK
MF_E_ATTRIBUTENOTFOUND
 La clé spécifiée est introuvable.
MF_E_INVALIDTYPE
 La valeur de l’attribut n’est pas une chaîne.

Remarques

Pour copier une valeur de chaîne dans une mémoire tampon allouée par l’appelant, utilisez la méthode IMFAttributes ::GetString .

Cette interface est disponible sur les plateformes suivantes si les composants redistribuables du SDK Windows Media Format 11 sont installés :

  • Windows XP avec Service Pack 2 (SP2) et versions ultérieures.
  • Windows XP Media Center Edition 2005 avec KB900325 (Windows XP Media Center Edition 2005) et KB925766 (correctif cumulatif d’octobre 2006 pour Windows XP Édition Media Center) installés.
Note Une version antérieure de la documentation indiquait à tort que le paramètre pcchLength peut être NULL. La définition de ce paramètre sur NULL peut réussir dans certains cas, mais n’est pas garantie. L’appelant doit passer un pointeur non NULL pour ce paramètre.
 

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows Vista [applications de bureau | applications UWP]
Serveur minimal pris en charge Windows Server 2008 [applications de bureau | applications UWP]
Plateforme cible Windows
En-tête mfobjects.h (inclure Mfidl.h)
Bibliothèque Mfuuid.lib

Voir aussi

Attributs et propriétés

IMFAttributes

MF_ATTRIBUTE_TYPE