Méthode IToc ::GetDescription (wmcodecdsp.h)

  • Article

La méthode GetDescription récupère la description, définie par un appel précédent à SetDescription, de la table des matières.

Syntaxe

HRESULT GetDescription(
  [in, out] WORD   *pwDescriptionSize,
  [out]     LPWSTR pwszDescription
);

Paramètres

[in, out] pwDescriptionSize

Si pwszDescription a la valeur NULL, il s’agit d’un paramètre de sortie qui reçoit la taille, en caractères larges, de la mémoire tampon requise pour recevoir la description. Si pwszDescription n’a pas la valeur NULL, il s’agit d’un paramètre d’entrée qui spécifie la taille, en caractères larges, du tampon alloué à l’appelant pointé vers pwszDescription.

[out] pwszDescription

NULL, ou un pointeur vers une mémoire tampon allouée à l’appelant qui, une fois la saisie terminée, reçoit la description. La description est terminée par 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_BUFFERTOOSMALL
 La méthode retourne ce code d’erreur si pwszDescription n’a pas la valeur NULL et si la description, y compris sa fin NULL, est supérieure à la taille spécifiée par pwDescriptionSize. Dans ce cas, pwDescriptionSize sert de paramètre de sortie et reçoit la taille de la mémoire tampon requise.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2008 [applications de bureau uniquement]
Plateforme cible Windows
En-tête wmcodecdsp.h
DLL Wmvdspa.dll

Voir aussi

IToc