StorPortCaptureLiveDump function (storport.h)

Article
02/22/2024

StorPortCaptureLiveDump captures a live dump file.

Syntax

ULONG StorPortCaptureLiveDump(
  [in]          PVOID                      HwDeviceExtension,
  [in/optional] PSTOR_ADDRESS              StorAddress,
  [in]          PSTORPORT_CAPTURE_LIVEDUMP CaptureLivedump
);

Parameters

[in] HwDeviceExtension

Pointer to the miniport's hardware device extension.

[in/optional] StorAddress

Pointer to a STOR_ADDRESS structure that holds the address specifying the unit object. Set StorAddress to NULL if the device is an adapter.

[in] CaptureLivedump

Pointer to a STORPORT_CAPTURE_LIVEDUMP structure containing the data needed to generate the live dump.

Return value

StorPortCaptureLiveDump returns one of the following values:

Return code	Description
STOR_STATUS_SUCCESS	The dump feature list was set successfully.
STOR_STATUS_INVALID_PARAMETER	One or more of the provided parameters are invalid.
STOR_STATUS_UNSUCCESSFUL	Returned for other internal system reasons.

Remarks

When a miniport detects an issue that might require further triage, it can call StorPortCaptureLiveDump to capture a live dump file.

This function must be called at PASSIVE_LEVEL.

Requirements

Requirement	Value
Minimum supported server	Windows Server 2022
Header	storport.h
IRQL	PASSIVE_LEVEL