IKsPropertySet::Set Method

The Set method sets the value of a property in a property set.

Syntax

HRESULT Set(
         REFGUID rguidPropSet,
         ULONG ulId,
         LPVOID pInstanceData,
         ULONG ulInstanceLength,
         LPVOID pPropertyData,
         ULONG ulDataLength
)

Parameters

  • rguidPropSet
    Reference to (C++) or address of (C) a GUID representing the property set to be accessed.
  • ulId
    Item within the property set to be accessed. Items are indexed from 0 and are always the same for a given property set.
  • pInstanceData
    Instance data for the set call. If there are multiple objects within the port that this operation could act on, the instance data specifies which object should be used.
  • ulInstanceLength
    Number of bytes pointed to by pInstanceData.
  • pPropertyData
    Property data to set for this item.
  • ulDataLength
    Number of bytes pointed to by pPropertyData.

Return Value

Return values are determined by the designer of the property set.

If the method succeeds, the return value may be S_OK.

If it fails, the method may return E_POINTER.

Remarks

The format of the data in both pInstanceData and pPropertyData is item-specific.

Requirements

Header: Declared in DSound.h.

Library: Use Dsound3d.dll.

See Also

IKsPropertySet