Share via

IOCTL_STREAM_STOP_SESSION

  • Article

This IOCTL is intended to stop either a receive or a transmit session created through the IOCTL_STREAM_START_RECV_SESSION IOCTL or the IOCTL_STREAM_START_XMIT_SESSION IOCTL. It will close the given connection, and make the provided session handle invalid.

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] 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_STOP_SESSION.
  • lpInBuffer
    [in] Must be filled in with a properly initialized STREAM_StopSession_Request structure. The vss_Session member must be pre-initialized.
  • nInBufferSize
    [in] Set to sizeof(STREAM_StopSession_Request).
  • lpOutBuffer
    [in] This field should be set to NULL for this IOCTL. There is no response structure associated with a stop session command.
  • nOutBufferSize
    [in] This field should be set to zero for this IOCTL.
  • 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 transmitting video data on that connection. As mentioned elsewhere, the current implementation of this API is DV-only; that means that the API does not currently support MPEG-2 transport streams.

Requirements

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

See Also

DeviceIoControl | IOCTL_STREAM_START_RECV_SESSION | IOCTL_STREAM_START_XMIT_SESSION | STREAM_StopSession_Request | CreateFile

 Last updated on Tuesday, May 18, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.