IOCTL_STREAM_DEREFERENCE_REMOTE_PLUG

  • Article

This IOCTL permits the caller to dereference any remote plug previously located through the IOCTL_STREAM_LOCATE_REMOTE_PLUG IOCTL, if necessary.

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_LOCATE_REMOTE_PLUG.
  • lpInBuffer
    [in] Must be filled in with a properly initialized STREAM_DereferenceRemotePlug_Request structure. The sdrp_PlugNumber, sdrp_PlugDirection, sdrp_SubunitPlugID, and sdrp_PlugToken members must be pre-initialized.
  • nInBufferSize
    [in] Set to sizeof(STREAM_DereferenceRemotePlug_Request).
  • lpOutBuffer
    [in] Unused; should be NULL.
  • nOutBufferSize
    [in] Unused; should be zero.
  • 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 may or may not take action. It should be called for each plug located by using IOCTL_STREAM_LOCATE_REMOTE_PLUG, as some AV/C connection mechanisms require that plugs connected to a subunit be deleted when no longer required.

Requirements

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

See Also

IOCTL_STREAM_LOCATE_REMOTE_PLUG | CreateFile | STREAM_DereferenceRemotePlug_Request | DeviceIoControl

 Last updated on Tuesday, May 18, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.