werapi.h header

This header is used by Windows Error Reporting (WER).

werapi.h contains the following programming interfaces:

Functions

WerAddExcludedApplication Adds the specified application to the list of applications that are to be excluded from error reporting.
WerFreeString Frees up the memory used to store a report key string. This should be called after each successive call to WerStoreGetFirstReportKey or WerStoreGetNextReportKey, once the particular report key string has been used and is no longer needed.
WerGetFlags Retrieves the fault reporting settings for the specified process.
WerRegisterAdditionalProcess Registers a process to be included in the Windows Error Reporting (WER) report along with the main application process. Optionally specifies a thread within that registered process to get additional data from.
WerRegisterAppLocalDump Registers a path (relative to the LocalFolder of the packaged application) where a copy should be saved of the diagnostic memory dump that Windows Error Reporting (WER) collects when one of the processes for the application stops responding.
WerRegisterCustomMetadata Registers app-specific metadata to be collected (in the form of key/value strings) for the Windows Error Reporting (WER) error report.
WerRegisterExcludedMemoryBlock Marks a memory block (that is normally included by default in error reports) to be excluded from the Windows Error Reporting (WER) error report.
WerRegisterFile Registers a file to be collected when Windows Error Reporting (WER) creates an error report.
WerRegisterMemoryBlock Registers a memory block to be collected when Windows Error Reporting (WER) creates an error report.
WerRegisterRuntimeExceptionModule Registers a custom runtime exception handler that is used to provide custom Windows Error Reporting (WER) for crashes.
WerRemoveExcludedApplication Removes the specified application from the list of applications that are to be excluded by Windows Error Reporting (WER).
WerReportAddDump Adds a dump of the specified type to the specified Windows Error Reporting (WER) report.
WerReportAddFile Adds a file to the specified Windows Error Reporting (WER) report.
WerReportCloseHandle Closes the specified Windows Error Reporting (WER) report.
WerReportCreate Creates a Windows Error Reporting (WER) report that describes an application event.
WerReportSetParameter Sets the parameters that uniquely identify an event for the specified Windows Error Reporting (WER) report.
WerReportSetUIOption Sets the user interface options for the specified Windows Error Reporting (WER) report.
WerReportSubmit Submits the specified Windows Error Reporting (WER) report.
WerSetFlags Sets the Windows Error Reporting (WER) reporting settings for the current process.
WerSetMaxProcessHoldMilliseconds Sets the maximum process hold time for Windows Error Reporting (WER), in milliseconds.
WerStoreClose Closes the collection of stored Windows Error Reporting (WER) reports.
WerStoreGetFirstReportKey Gets a reference to the first Windows Error Reporting (WER) report in the report store.
WerStoreGetNextReportKey Gets a reference to the next Windows Error Reporting (WER) report in the error report store.
WerStoreGetReportCount Gets the number of Windows Error Reporting (WER) reports in the error report store.
WerStoreGetSizeOnDisk Gets the size of the Windows Error Reporting (WER) error report store, in bytes.
WerStoreOpen Opens the collection of stored Windows Error Reporting (WER) error reports.
WerStorePurge Purges the Windows Error Reporting (WER) report store.
WerStoreQueryReportMetadataV1 Retrieves metadata about a Windows Error Reporting (WER) report in the store.
WerStoreQueryReportMetadataV2 Retrieves metadata about a Windows Error Reporting (WER) report in the store.
WerStoreQueryReportMetadataV3 Retrieves metadata about a Windows Error Reporting (WER) report in the store.
WerStoreUploadReport Uploads a report to the Windows Error Reporting (WER) store.
WerUnregisterAdditionalProcess Removes a process from the list of additional processes to be included in the Windows Error Reporting (WER) error report.
WerUnregisterAppLocalDump Cancels the registration that was made by calling the WerRegisterAppLocalDump function to specify that Windows Error Reporting (WER) should save a copy of the diagnostic memory dump that WER collects when one of the processes for the application stops responding.
WerUnregisterCustomMetadata Removes an item of app-specific metadata being collected during Windows Error Reporting (WER) for the application.
WerUnregisterExcludedMemoryBlock Removes a memory block that was previously marked as excluded, which will again be included in Windows Error Reporting] (WER) error reports.
WerUnregisterFile Removes a file from the list of files to be added to Windows Error Reporting (WER) reports generated for the current process.
WerUnregisterMemoryBlock Removes a memory block from the list of data to be collected during Windows Error Reporting (WER) for the application.
WerUnregisterRuntimeExceptionModule Removes the registration of the Windows Error Reporting (WER) exception handler.

Callback functions

PFN_WER_RUNTIME_EXCEPTION_DEBUGGER_LAUNCH Windows Error Reporting (WER) calls this function to let you customize the debugger launch options and launch string.
PFN_WER_RUNTIME_EXCEPTION_EVENT Windows Error Reporting (WER) calls this function to determine whether the exception handler is claiming the crash.
PFN_WER_RUNTIME_EXCEPTION_EVENT_SIGNATURE Windows Error Reporting (WER) calls this function to get the report parameters that uniquely describe the problem.

Structures

WER_DUMP_CUSTOM_OPTIONS Specifies custom Windows Error Reporting (WER) minidump information to be collected by the WerReportAddDump function.
WER_DUMP_CUSTOM_OPTIONS_V2 Specifies custom Windows Error Reporting (WER) minidump information to be collected by the WerReportAddDump function.
WER_DUMP_CUSTOM_OPTIONS_V3 Specifies custom Windows Error Reporting (WER) minidump information to be collected in the background (without pausing the process) by the PssCaptureSnapshot function.
WER_EXCEPTION_INFORMATION Contains Windows Error Reporting (WER) exception information for the WerReportAddDump function.
WER_REPORT_INFORMATION Contains Windows Error Reporting (WER) information used by the WerReportCreate function.
WER_REPORT_INFORMATION_V3 Contains Windows Error Reporting (WER) information used by the WerReportCreate function.
WER_REPORT_INFORMATION_V4 Contains Windows Error Reporting] (WER) information used by the WerReportCreate function.
WER_REPORT_INFORMATION_V5 Contains Windows Error Reporting (WER) information used by the WerReportCreate function.
WER_REPORT_METADATA_V1 Contains information about an error report generated by Windows Error Reporting (WER).
WER_REPORT_METADATA_V2 Contains information about an error report generated by Windows Error Reporting (WER).
WER_REPORT_METADATA_V3 Contains information about an error report generated by Windows Error Reporting (WER).
WER_REPORT_PARAMETER Contains information about an error report parameter generated by Windows Error Reporting (WER).
WER_REPORT_SIGNATURE Contains information about an error report signature generated by Windows Error Reporting (WER).
WER_RUNTIME_EXCEPTION_INFORMATION Contains the Windows Error Reporting (WER) exception information used to determine whether you want to claim the crash.

Enumerations

REPORT_STORE_TYPES Defines the types of Windows Error Reporting (WER) report stores that can be opened.
WER_CONSENT Defines the possible Windows Error Reporting (WER) user consent states.
WER_DUMP_TYPE Defines the possible Windows Error Reporting (WER) minidump types.
WER_FILE_TYPE Defines the possible Windows Error Reporting (WER) file types for the minidump report.
WER_REGISTER_FILE_TYPE Defines the Windows Error Reporting (WER) file types that can be registered.
WER_REPORT_TYPE Defines the Windows Error Reporting (WER) report types.
WER_REPORT_UI Defines the indexes of the Windows Error Reporting (WER) report's customizable UI strings.
WER_SUBMIT_RESULT Defines the Windows Error Reporting (WER) submission result options.