IOCTL_CS_PROPERTY (Compact 2013)

3/26/2014

This I/O control message is used to get or set property values and to determine whether a property is supported. Filters and pins support property sets using IOCTL_CS_PROPERTY. Send this message with DeviceIoControl.

Syntax

BOOL DeviceIoControl(
    HANDLE hDevice,           // handle to device
    DWORD dwIoControlCode,    // use IOCTL_CS_PROPERTY
    LPVOID lpInBuffer,        // pointer to input buffer
    DWORD nInBufferSize,      // input buffer size
    LPVOID lpOutBuffer,       // pointer to output buffer
    DWORD nOutBufferSize,     // output buffer size
    LPDWORD lpBytesReturned,  // number of bytes returned
    OVERLAPPED lpOverlapped   // pointer to OVERLAPPED structure
);

Parameters

• hDevice
  [in] Handle to the device.

• dwIoControlCode
  [in] Control code for the operation. Use IOCTL_CS_PROPERTY for this operation.

• lpInBuffer
  [in] Pointer to a client-specified input buffer. The buffer's type is called the property descriptor type and depends on the requested property in a property set. For example, requests for properties in the CSPROPSETID_Pin property set are associated with values in the CSPROPERTY_PIN enumeration. The property descriptor type for the CSPROPERTY_PIN_CINSTANCES property is CSP_PIN. For more information, see the Remarks section.

• nInBufferSize
  [in] Set to the size of the pointer in lpInBuffer.

• lpOutBuffer
  [out] A pointer to a client-specified output buffer. The buffer's type is called the property value type and depends on the requested property in a property set. For example, requests for properties in the CSPROPSETID_Pin property set are associated with values in the CSPROPERTY_PIN enumeration. The property value type for the CSPROPERTY_PIN_CINSTANCES property is CSPIN_CINSTANCES.

• nOutBufferSize

• lpBytesReturned
  Ignored.

• lpOverlapped
  [in] Set to NULL.

Return Values

Returns TRUE if successful; otherwise, returns FALSE. If it returns TRUE, then the bUnitReady member of CDROM_TESTUNITREADY is also set to TRUE.

Remarks

To get extended error information, call GetLastError. GetLastError may return other standard error messages as appropriate.

Remarks

Although this IOCTL is defined with the METHOD_NEITHER flag, the property data is passed as the output buffer to the IOCTL and probed for read access.

The following table shows the property sets that a camera adapter may support.

Property Set ID	Associated Properties
CSPROPSETID_Pin	CSPROPERTY_PIN
PROPSETID_VIDCAP_VIDEOPROCAMP	CSPROPERTY_VIDCAP_VIDEOPROCAMP
PROPSETID_VIDCAP_CAMERACONTROL	CSPROPERTY_VIDCAP_CAMERACONTROL
PROPSETID_VIDCAP_COMPRESSION	CSPROPERTY_VIDCAP_VIDEOCOMPRESSION
PROPSETID_VIDCAP_VIDEOCONTROL	CSPROPERTY_VIDCAP_VIDEOCONTROL

The following table shows the property sets that a stream may support.

Property Set ID	Associated Properties
PROPSETID_VIDCAP_DROPPEDFRAMES	CSPROPERTY_VIDCAP_DROPPEDFRAMES
CSPROPSETID_Connection	CSPROPERTY_CONNECTION

Requirements

Header

csmedia.h

See Also

Reference

Camera Driver IOCTLs
DeviceIoControl
CSPROPERTY_PIN
CSP_PIN
CSPIN_CINSTANCES