| Microsoft DirectX 9.0 SDK Update (October 2004) |
The KsProperty method retrieves or sets the value of a property. For an overview, see Property Sets for DirectMusic Ports.
Syntax
HRESULT KsProperty(
PKSPROPERTY pProperty,
ULONG ulPropertyLength,
LPVOID pvPropertyData,
ULONG ulDataLength,
PULONG pulBytesReturned
);
Parameters
pProperty
Address of a KSPROPERTY structure that gives the property set, item, and operation to perform. If this property contains instance data, that data should reside in memory immediately following the structure.
ulPropertyLength
Length of the memory pointed to by pProperty, including any instance data.
pvPropertyData
For a set operation, the address of a memory buffer containing data that represents the new value of the property. For a get operation, the address of a memory buffer big enough to hold the value of the property. For a basic support query, the address of a buffer at least a DWORD in size.
ulDataLength
Length of the buffer pointed to by pvPropertyData.
pulBytesReturned
On a KSPROPERTY_TYPE_GET or KSPROPERTY_TYPE_BASICSUPPORT call, address of a variable that receives the number of bytes returned in pvPropertyData by the port.
Return Values
If the method succeeds, it returns S_OK.
If it fails, the method can return one of the error values shown in the following table.
| Return code |
| E_FAIL |
| E_INVALIDARG |
| E_NOTIMPL |
| E_OUTOFMEMORY |
| E_POINTER |
| DMUS_E_UNKNOWN_PROPERTY |
Requirements
Header: Declared in dmksctrl.h.
See Also