IKsPropertySet::Get method (ksproxy.h)
The Get method retrieves a property identified by a property-set GUID and a property identifier.
Syntax
HRESULT Get(
[in] REFGUID PropSet,
[in] ULONG Id,
[in] LPVOID InstanceData,
[in] ULONG InstanceLength,
[out] LPVOID PropertyData,
[in] ULONG DataLength,
[out] ULONG *BytesReturned
);
Parameters
[in] PropSet
GUID that identifies the property set.
[in] Id
Identifier of the property within the property set.
[in] InstanceData
Pointer to instance data for the property.
[in] InstanceLength
Size, in bytes, of the buffer at InstanceData.
[out] PropertyData
Pointer to a buffer that receives the value of the property.
[in] DataLength
Size, in bytes, of the buffer at PropertyData.
[out] BytesReturned
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. 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 | ksproxy.h (include Ksproxy.h, Dsound.h) |