Méthode ITocEntry ::GetTitle (wmcodecdsp.h)

  • Article

La méthode GetTitle récupère le titre, défini par un appel précédent à SetTitle, de l’entrée.

Syntaxe

HRESULT GetTitle(
  [in, out] WORD   *pwTitleSize,
  [out]     LPWSTR pwszTitle
);

Paramètres

[in, out] pwTitleSize

Si pwszTitle 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 le titre. Si pwszTitle 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, de la mémoire tampon allouée à l’appelant pointée vers pwszTitle.

[out] pwszTitle

NULL, ou pointeur vers une mémoire tampon allouée par l’appelant qui, une fois l’exécution réussie, reçoit le titre. Le titre est terminé 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 pwszTitle n’a pas la valeur NULL et si le titre, y compris son terminateur NULL, est supérieur à la taille spécifiée par pwTitleSize. Dans ce cas, pwTitleSize 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

ITocEntry

SetTitle