IKsPropertySet::Get method (dsound.h)

Article
09/19/2022

The Get method retrieves a property identified by a property-set GUID and a property identifier.

Syntax

HRESULT Get(
  [in]  REFGUID rguidPropSet,
  [in]  ULONG   ulId,
  [in]  LPVOID  pInstanceData,
  [in]  ULONG   ulInstanceLength,
  [out] LPVOID  pPropertyData,
  [in]  ULONG   ulDataLength,
  [out] PULONG  pulBytesReturned
);

Parameters

[in] rguidPropSet

GUID that identifies the property set.

[in] ulId

Identifier of the property within the property set.

[in] pInstanceData

Pointer to instance data for the property.

[in] ulInstanceLength

Size, in bytes, of the buffer at InstanceData.

[out] pPropertyData

Pointer to a buffer that receives the value of the property.

[in] ulDataLength

Size, in bytes, of the buffer at PropertyData.

[out] pulBytesReturned

Pointer to a variable that receives the size, in bytes, of the data that Get stores in the buffer at PropertyData.

Return value

Returns NOERROR if successful; otherwise, returns an error code.

Remarks

To retrieve a property, allocate a buffer, which Get fills with the property. To determine the necessary buffer size, specify NULL for PropertyData and zero for DataLength. The Get method returns the required buffer size in BytesReturned.

Warning

Header files ksproxy.h and dsound.h define similar but incompatible versions of the IKsPropertySet interface. Applications that require the KS proxy module should use the version defined in ksproxy.h. The DirectSound version of IKsPropertySet is described in the DirectSound reference pages in the Microsoft Windows SDK documentation. If an application must include both ksproxy.h and dsound.h, whichever header file the compiler scans first is the one whose definition of IKsPropertySet is used by the compiler.

Requirements

Requirement	Value
Target Platform	Desktop
Header	dsound.h (include Ksproxy.h, Dsound.h)