IOCTL_STREAM_GET_REMOTE_PLUG_HANDLE

  • Article

This IOCTL permits the caller to obtain a reference to a Serial Bus plug on a remote node.

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_GET_REMOTE_PLUG_HANDLE.
  • lpInBuffer
    [in] Must be filled in with a properly initialized STREAM_GetRemotePlugHandle_Request structure. The sgrph_PlugNumber and sgrph_PlugDirection members must be pre-initialized.
  • nInBufferSize
    [in] Set to sizeof(STREAM_GetRemotePlugHandle_Request).
  • lpOutBuffer
    [out] Must point to a STREAM_GetRemotePlugHandle_Response structure.
  • nOutBufferSize
    [in] Set to sizeof(STREAM_GetRemotePlugHandle_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 permits the calling application to obtain a reference to a serial bus plug on a remote node. This is a requirement for starting a receive or transmit session with the remote subunit.

The developer should utilize the IOCTL_STREAM_LOCATE_REMOTE_PLUG IOCTL to determine which serial bus plug on the remote device to connect to. Only after exhausting attempts to determine the correct plug number should the developer use a default constant value such as zero.

Requirements

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

See Also

IOCTL_STREAM_CREATE_LOCAL_PLUG | IOCTL_STREAM_DELETE_LOCAL_PLUG | IOCTL_STREAM_START_RECV_SESSION | IOCTL_STREAM_START_XMIT_SESSION | IOCTL_STREAM_LOCATE_REMOTE_PLUG | CreateFile | STREAM_GetRemotePlugHandle_Request | STREAM_GetRemotePlugHandle_Response | DeviceIoControl

 Last updated on Tuesday, May 18, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.