WDF_IO_TARGET_OPEN_PARAMS_INIT_REOPEN function (wdfiotarget.h)

Article
02/22/2024

[Applies to KMDF and UMDF]

The WDF_IO_TARGET_OPEN_PARAMS_INIT_REOPEN function initializes a driver's WDF_IO_TARGET_OPEN_PARAMS structure so the driver can reopen a remote I/O target.

Syntax

void WDF_IO_TARGET_OPEN_PARAMS_INIT_REOPEN(
  [out] PWDF_IO_TARGET_OPEN_PARAMS Params
);

Parameters

[out] Params

A pointer to a driver-allocated WDF_IO_TARGET_OPEN_PARAMS structure, which the function initializes.

Return value

None

Remarks

The WDF_IO_TARGET_OPEN_PARAMS structure is used as input to the WdfIoTargetOpen method. Your driver should call WDF_IO_TARGET_OPEN_PARAMS_INIT_REOPEN to initialize a WDF_IO_TARGET_OPEN_PARAMS structure if the driver is calling WdfIoTargetOpen from within an EvtIoTargetRemoveCanceled callback function.

The WDF_IO_TARGET_OPEN_PARAMS_INIT_REOPEN function zeros the specified WDF_IO_TARGET_OPEN_PARAMS structure and sets the structure's Size member. Then, the function sets the Type member to WdfIoTargetOpenReopen.

For more information about I/O targets, see Using I/O Targets.

Examples

The following code example is a segment of an EvtIoTargetRemoveCanceled callback function that reopens a remote I/O target.

VOID
MyEvtIoTargetRemoveCanceled(
    WDFIOTARGET IoTarget
    )
{
    WDF_IO_TARGET_OPEN_PARAMS openParams;
    NTSTATUS status;

...
    WDF_IO_TARGET_OPEN_PARAMS_INIT_REOPEN(&openParams);
    status = WdfIoTargetOpen(
                             IoTarget,
                             &openParams
                             );
...
}

Requirements

Requirement	Value
Target Platform	Universal
Minimum KMDF version	1.0
Minimum UMDF version	2.0
Header	wdfiotarget.h (include Wdf.h)
IRQL	Any level

Share via