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

Article
03/04/2024

La méthode GetDescriptionData obtient un bloc de données de description précédemment associé à l’entrée par un appel à SetDescriptionData.

Syntaxe

HRESULT GetDescriptionData(
  [in, out] DWORD *pdwDescriptionDataSize,
  [out]     BYTE  *pbtDescriptionData,
  [out]     GUID  *pGuidType
);

Paramètres

[in, out] pdwDescriptionDataSize

Si pbtDescriptionData a la valeur NULL, il s’agit d’un paramètre de sortie qui reçoit la taille, en octets, du bloc de données de description. Si pbtDescriptionData n’a pas la valeur NULL, il s’agit d’un paramètre d’entrée qui spécifie la taille, en octets, de la mémoire tampon allouée à l’appelant pointée par pbtDescriptionData.

[out] pbtDescriptionData

NULL, ou pointeur vers une mémoire tampon allouée par l’appelant qui, une fois l’exécution réussie, reçoit le bloc de données de description.

[out] pGuidType

Pointeur vers une variable qui reçoit un identificateur global unique (GUID) qui identifie le type de données dans le bloc de données de description. Consultez la section Notes.

Valeur de retour

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 pbtDescriptionData n’a pas la valeur NULL et si le bloc de contexte est supérieur à la taille spécifiée par pdwDescriptionDataSize. Dans ce cas, pdwDescriptionDataSize sert de paramètre de sortie et reçoit la taille, en octets, de la mémoire tampon requise.

Remarques

Vous ne pouvez associer qu’un seul bloc de données de description à une entrée donnée à un moment donné. Toutefois, vous pouvez concevoir différents types de blocs de données de description et identifier chaque type de bloc avec un identificateur global unique (GUID). De cette façon, lorsque vous appelez SetDescriptionData, vous pouvez marquer le bloc de données comme étant d’un type spécifique. Lorsque vous appelez GetDescriptionData, vous pouvez déterminer le type du bloc de données récupéré en inspectant la valeur retournée dans pGuidType.

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

SetDescriptionData

Partager via