Edit

Share via

StorPortPause function (storport.h)

  • Article

The StorPortPause routine pauses an adapter for the specified period of time.

Syntax

STORPORT_API BOOLEAN StorPortPause(
  [in] PVOID HwDeviceExtension,
       ULONG Timeout
);

Parameters

[in] HwDeviceExtension

Pointer to the hardware device extension of the adapter to pause. This is a per-HBA storage area that the port driver allocates and initializes on behalf of the miniport driver. Miniport drivers usually store HBA-specific information in this extension, such as the state of the HBA and the mapped access ranges for the HBA. This area is available to the miniport driver immediately after the miniport driver calls StorPortInitialize. The port driver frees this memory when it removes the device.

Timeout

Specifies the interval of time, in seconds, that the adapter is to be paused.

Return value

StorPortPause returns TRUE if the miniport driver succeeded in pausing the adapter, FALSE if not.

Remarks

All requests to the adapter are held until the time-out expires or the device resumes. All requests to all targets attached to the adapter will be held until the adapter is resumed or the time-out expires.

Requirements

Requirement Value
Target Platform Universal
Header storport.h (include Storport.h)
Library Storport.lib

See also

StorPortResume