Partager via


IKsControl ::KsProperty, méthode (ksproxy.h)

La méthode KsProperty définit une propriété ou récupère les informations de propriété, ainsi que les autres opérations de support définies disponibles sur un jeu de propriétés.

Syntaxe

HRESULT KsProperty(
  [in]      PKSPROPERTY Property,
  [in]      ULONG       PropertyLength,
  [in, out] LPVOID      PropertyData,
  [in]      ULONG       DataLength,
  [in, out] ULONG       *BytesReturned
);

Paramètres

[in] Property

Pointeur vers une structure qui décrit une propriété et le type de requête de la demande de propriété. Cette structure doit être une KSPROPERTY ou une structure qui contient une structure KSPROPERTY en tant que premier membre. Un exemple de structure pouvant être pointée par ce membre est la structure KSPROPERTY_VIDEOPROCAMP_S.

[in] PropertyLength

Taille, en octets, de la mémoire tampon à Propriété.

[in, out] PropertyData

Pointeur vers une mémoire tampon qui contient des données pour une opération de KSPROPERTY_TYPE_SET, de KSPROPERTY_TYPE_UNSERIALIZESET ou de KSPROPERTY_TYPE_UNSERIALIZERAW ou d’espace tampon qui reçoit des données pour toutes les autres opérations.

[in] DataLength

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

[in, out] BytesReturned

Pointeur vers une variable qui reçoit la taille, en octets, des données qui KsProperty stocke dans la mémoire tampon à PropertyData. Si aucune donnée n’est stockée, la taille est égale à zéro.

Valeur de retour

Retourne NOERROR en cas de réussite ; sinon, retourne un code d’erreur.

Remarques

Pour déterminer la taille de mémoire tampon requise pour une requête de propriété spécifique, vous pouvez appeler cette méthode avec PropertyData défini sur NULL et DataLength égal à zéro. La méthode retourne HRESULT_FROM_WIN32(ERROR_MORE_DATA) et octetsReturned contient la taille de la mémoire tampon requise.

Exigences

Exigence Valeur
plateforme cible DesktopMobile
d’en-tête ksproxy.h (include Ksproxy.h)

Voir aussi

KSPROPERTY

KSPROPERTY_VIDEOPROCAMP_S