IOCTL_STREAM_START_RECV_SESSION

  • Article

This IOCTL permits the caller to initiate a receive session, that is, set up the connection and details to be able to receive DV, MPEG, audio, or other isochronous data from the device.

Parameters

  • hDevice
    [in] Handle to the target object. To get a device handle, call the CreateFile function with a name dynamically obtained from the SetupDiEnumDeviceInterfaces function.
  • dwIoControlCode
    [in] The IOCTL for the operation. This value identifies the target operation and the type of device on which to perform the operation. For this operation, use IOCTL_STREAM_START_RECV_SESSION.
  • lpInBuffer
    [in] Must be filled in with a properly initialized STREAM_StartReceiveSession_Request structure. The ssrs_RemotePlug, ssrs_LocalPlug, ssrs_MediaType, and ssrs_ClusterDimension members must be pre-initialized.
  • nInBufferSize
    [in] Set to sizeof(STREAM_StartReceiveSession_Request).
  • lpOutBuffer
    [out] Must point to a STREAM_StartReceiveSession_Response structure.
  • nOutBufferSize
    [in] Set to sizeof(STREAM_StartReceiveSession_Response).
  • lpBytesReturned
    [out] Pointer to a DWORD variable that receives the actual count of bytes returned by the function in the output buffer.
  • lpOverlapped
    [out] If not used, set to NULL. Otherwise, this should point to a completely filled out OVERLAPPED structure that contains a valid event. The event will be signaled when the I/O operation is complete.

Return Values

If the operation succeeds, the DeviceIoControl function returns a non-zero value. If the operation fails, DeviceIoControl returns zero. To obtain extended error information, call the GetLastError function.

Remarks

This IOCTL sets up the details of generating a connection to the device in question on the given AV/C plug and listening on that connection for video data.

Requirements

OS Versions: Windows CE .NET 4.0 and later.
Header: Avc_stream.h.

See Also

DeviceIoControl | IOCTL_STREAM_ATTACH_BUFFER | IOCTL_STREAM_DETACH_BUFFER | IOCTL_STREAM_QUERY_BUFFER_STATE | IOCTL_STREAM_STOP_SESSION | CreateFile | STREAM_StartReceiveSession_Request | STREAM_StartReceiveSession_Response

 Last updated on Tuesday, May 18, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.