LkmdTelCreateReport function (lkmdtel.h)
This function initializes a new live kernel dump telemetry report, and returns an opaque handle of the report to the caller for use with subsequent LkmdTel functions.
Syntax
HANDLE LkmdTelCreateReport(
PWCHAR ReportType,
ULONG BugCheckCode,
ULONG_PTR BugCheckParam1,
ULONG_PTR BugCheckParam2,
ULONG_PTR BugCheckParam3,
ULONG_PTR BugCheckParam4
);
Parameters
ReportType
This parameter defines the report type string. For example, for xHCI, this value is defined as L”USBXHCI”. For a Silicon partner developing a collection of drivers, only one ReportType string should be used.
The maximum report type name length is 16 Unicode characters, including the terminating NULL.
BugCheckCode
This value is the kernel live dump code. For example, SoC subsystem restart would use SOC_SUBSYSTEM_FAILURE_LIVEDUMP (0x15d)
BugCheckParam1
Defined per component, this supplies the first parameter to set in the dump.
BugCheckParam2
Defined per component, this supplies the second parameter to set in the dump.
BugCheckParam3
Defined per component, this supplies the third parameter to set in the dump.
BugCheckParam4
Defined per component, this supplies the fourth parameter to set in the dump.
Return value
This function returns an opaque handle to the telemetry data which can be used with the LkmdTelSubmitReport, LkmdTelSetSecondaryData, and LkmdTelInsertTriageDataBlock functions. This handle is closed using LkmdTelCloseHandle.
In the case of failure, the handle returns NULL.
Remarks
- This function must be called first, since it allocates the data structure used to store the telemetry data. It returns the telemetry handle.
- The Telemery Report handle is closed using LkmdTelCloseHandle.
Requirements
Requirement | Value |
---|---|
Header | lkmdtel.h |
Library | lkmdtel.lib, \werkernelapi.lib |
IRQL | PASSIVE_LEVEL |