IKsControl::KsProperty

The IKsControl::KsProperty method gets or sets the value of a property. For an overview, see Port Property Sets.

HRESULT KsProperty(
  PKSPROPERTY pProperty, 
  ULONG ulPropertyLength,
  LPVOID pvPropertyData,
  ULONG ulDataLength,
  PULONG pulBytesReturned
);
 

Parameters

pProperty

Pointer to a KSPROPERTY structure that gives the property set, item, and operation to perform. If this property contains instance data, then that data should reside in memory immediately following the structure.

ulPropertyLength

The length of the memory pointed to by pProperty, including any instance data.

pvPropertyData

For a set operation, a memory buffer containing data representing the new value of the property. For a get operation, a memory buffer big enough to hold the value of the property. For a basic support query, a pointer to a buffer at least the size of a DWORD.

ulDataLength

The length of the buffer pointed to by pvPropertyData.

pulBytesReturned

On a KSPROPERTY_TYPE_GET or KSPROPERTY_TYPE_BASICSUPPORT call, the number of bytes returned in pvPropertyData by the port.

Return Values

If the method succeeds, it returns S_OK.

If the it fails, the method may return one of the following error values:

QuickInfo

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in dmksctrl.h.

See Also

Port Property Sets