IKsPropertySet::Get, méthode (ksproxy.h)

La méthode Get récupère une propriété identifiée par un GUID de jeu de propriétés et un identificateur de propriété.

Syntaxe

HRESULT Get(
  [in]  REFGUID PropSet,
  [in]  ULONG   Id,
  [in]  LPVOID  InstanceData,
  [in]  ULONG   InstanceLength,
  [out] LPVOID  PropertyData,
  [in]  ULONG   DataLength,
  [out] ULONG   *BytesReturned
);

Paramètres

[in] PropSet

GUID qui identifie le jeu de propriétés.

[in] Id

Identificateur de la propriété dans le jeu de propriétés.

[in] InstanceData

Pointeur vers les données d’instance de la propriété.

[in] InstanceLength

Taille, en octets, de la mémoire tampon sur InstanceData.

[out] PropertyData

Pointeur vers une mémoire tampon qui reçoit la valeur de la propriété.

[in] DataLength

Taille, en octets, de la mémoire tampon sur PropertyData.

[out] BytesReturned

Pointeur vers une variable qui reçoit la taille, en octets, des données qui sont stockées dans la mémoire tampon sur PropertyData.

Valeur de retour

Retourne NOERROR si elle réussit ; sinon, retourne un code d’erreur.

Remarques

Pour récupérer une propriété, allouez une mémoire tampon, qui obtient des remplissages avec la propriété. Pour déterminer la taille de mémoire tampon nécessaire, spécifiez NULL pour PropertyData et zéro pour DataLength. La méthode Get retourne la taille de mémoire tampon requise dans BytesReturned.

Avertissement  

Les fichiers d’en-tête ksproxy.h et dsound.h définissent des versions similaires mais incompatibles de l’interface IKsPropertySet . Les applications qui nécessitent le module proxy KS doivent utiliser la version définie dans ksproxy.h. La version DirectSound d’IKsPropertySet est décrite dans les pages de référence DirectSound de la documentation Microsoft Windows SDK.

Si une application doit inclure ksproxy.h et dsound.h, quel que soit le fichier d’en-tête que le compilateur analyse en premier est celui dont la définition d’IKsPropertySet est utilisée par le compilateur.

 

Configuration requise

   
Plateforme cible Desktop (Expérience utilisateur)
En-tête ksproxy.h (include Ksproxy.h, Dsound.h)

Voir aussi

IKsPropertySet::Set