IWDFRemoteTarget::Close method

The Close method closes a remote I/O target.

Syntax


HRESULT Close();

Parameters

This method has no parameters.

Return value

The Close method always returns S_OK.

Remarks

If your driver provides an IRemoteTargetCallbackRemoval::OnRemoteTargetRemoveComplete callback function, the callback function must call Close.

The Close method completes or cancels all I/O requests that the driver has sent to the I/O target.

After a driver calls Close, the driver cannot send I/O requests to the I/O target.

For more information about the Close method, see Controlling a General I/O Target's State in UMDF.

Examples

The following code example shows an IRemoteTargetCallbackRemoval::OnRemoteTargetRemoveComplete callback function that calls Close.


VOID 
STDMETHODCALLTYPE
CMyRemoteTarget::OnRemoteTargetRemoveComplete(
    __in IWDFRemoteTarget *FxTarget
    )
{
    //
    // Here, do any driver-specific actions that your driver requires
    // to close the remote I/O target.
    //
...
    //
    // Close the target.
    //
    FxTarget->Close();
}

Requirements

End of support

Unavailable in UMDF 2.0 and later.

Minimum UMDF version

1.9

Header

Wudfddi.h (include Wudfddi.h)

DLL

WUDFx.dll

See also

IWDFRemoteTarget
IWDFRemoteTarget::CloseForQueryRemove

 

 

Send comments about this topic to Microsoft

Mostrar:
© 2014 Microsoft