Partager via


Méthode IKsControl ::KsProperty (ksproxy.h)

La méthode KsProperty définit une propriété ou récupère des informations de propriété, ainsi que toutes les autres opérations de prise en charge 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 structure KSPROPERTY ou une structure qui contient une structure KSPROPERTY comme premier membre. La structure KSPROPERTY_VIDEOPROCAMP_S est un exemple de structure vers laquelle ce membre peut pointer.

[in] PropertyLength

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

[in, out] PropertyData

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

[in] DataLength

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

[in, out] BytesReturned

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

Valeur retournée

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 demande 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 BytesReturned contient la taille de la mémoire tampon requise.

Configuration requise

Condition requise Valeur
Plateforme cible DesktopMobile
En-tête ksproxy.h (inclure Ksproxy.h)

Voir aussi

KSPROPERTY

KSPROPERTY_VIDEOPROCAMP_S