FGenericErrorReport Class Reference

#include <GenericErrorReport.h>

Inheritance diagram for FGenericErrorReport:

Public Member Functions
	FGenericErrorReport ()
	FGenericErrorReport (const FString &Directory)
bool	SetUserComment (const FText &UserComment)
void	SetPrimaryCrashProperties (FPrimaryCrashProperties &out_PrimaryCrashProperties)
void	SetCrashReportClientVersion (const FString &InVersion)
TArray< FString >	GetFilesToUpload () const
TArray< FString >	GetOptionalAttachmentsToUpload () const
bool	LoadWindowsReportXmlFile (FString &OutString) const
bool	TryReadDiagnosticsFile ()
FString	GetReportDirectory () const
FString	GetReportDirectoryLeafName () const
FString	FindCrashedAppName () const
FString	FindCrashedAppPath () const
bool	HasFilesToUpload () const
bool	FindFirstReportFileWithExtension (FString &OutFilename, const TCHAR *Extension) const
void	DeleteFiles ()

Static Public Member Functions
static void	Init ()
static void	ShutDown ()

Protected Attributes
FString	ReportDirectory
TArray< FString >	ReportFilenames
FString	OptionalAttachmentsDirectory
TArray< FString >	OptionalAttachmentsFilenames
bool	bValidCallstack

Detailed Description

Helper that works with Windows Error Reports

Constructor & Destructor Documentation

FGenericErrorReport() [1/2]

FGenericErrorReport::FGenericErrorReport ( )

inline

Default constructor: creates a report with no files

FGenericErrorReport() [2/2]

FGenericErrorReport::FGenericErrorReport ( const FString &  Directory )

explicit

Discover all files in the crash report directory

Parameters

Directory

Full path to directory containing the report

Member Function Documentation

DeleteFiles()

void FGenericErrorReport::DeleteFiles

(

)

Delete files from disk

FindCrashedAppName()

FString FGenericErrorReport::FindCrashedAppName

(

)

const

Get the name of the crashed app from the report

FindCrashedAppPath()

FString FGenericErrorReport::FindCrashedAppPath

(

)

const

Get the full path of the crashed app from the report

FindFirstReportFileWithExtension()

bool FGenericErrorReport::FindFirstReportFileWithExtension	(	FString &	OutFilename,
		const TCHAR *	Extension
	)		const

Look thought the list of report files to find one with the given extension

Returns

Whether a file with the extension was found

GetFilesToUpload()

TArray< FString > FGenericErrorReport::GetFilesToUpload

(

)

const

Provide full paths to all the report files

Returns

List of paths

GetOptionalAttachmentsToUpload()

TArray< FString > FGenericErrorReport::GetOptionalAttachmentsToUpload

(

)

const

Provide full paths to all the report's optional attachment files

Returns

List of paths

GetReportDirectory()

FString FGenericErrorReport::GetReportDirectory ( ) const

inline

Provide the full path of the error report directory

GetReportDirectoryLeafName()

FString FGenericErrorReport::GetReportDirectoryLeafName ( ) const

inline

Provide the name of the error report directory

HasFilesToUpload()

bool FGenericErrorReport::HasFilesToUpload ( ) const

inline

Is there anything to upload?

Init()

static void FGenericErrorReport::Init ( )

inlinestatic

One-time initialisation: does nothing by default

LoadWindowsReportXmlFile()

bool FGenericErrorReport::LoadWindowsReportXmlFile

(

FString &

OutString

)

const

Load the WER XML file for this report

Note

This is Windows specific and so shouldn't really be part of the public interface, but currently the server is Windows-specific in its checking of reports, so this is needed.

Parameters

OutString

String to load the file into

Returns

Whether finding and loading the file succeeded

SetCrashReportClientVersion()

void FGenericErrorReport::SetCrashReportClientVersion

(

const FString &

InVersion

)

Sets the version string in the error report and saves the change

SetPrimaryCrashProperties()

void FGenericErrorReport::SetPrimaryCrashProperties

(

FPrimaryCrashProperties &

out_PrimaryCrashProperties

)

Sets properties specific to the processed crash. Used to convert the old data into the crash context format.

SetUserComment()

bool FGenericErrorReport::SetUserComment

(

const FText &

UserComment

)

Write the provided comment into the error report

Parameters

UserComment

Information provided by the user to add to the report

Returns

Whether the comment was successfully written to the report

ShutDown()

static void FGenericErrorReport::ShutDown ( )

inlinestatic

One-time clean-up: does nothing by default

TryReadDiagnosticsFile()

bool FGenericErrorReport::TryReadDiagnosticsFile

(

)

Returns

Whether the file was found and successfully read

Member Data Documentation

bValidCallstack

bool FGenericErrorReport::bValidCallstack

mutableprotected

Whether the error report generated an valid callstack.

OptionalAttachmentsDirectory

FString FGenericErrorReport::OptionalAttachmentsDirectory

protected

Full path to the directory the report's optional attachment files are in

OptionalAttachmentsFilenames

TArray<FString> FGenericErrorReport::OptionalAttachmentsFilenames

protected

List of leaf filenames of all the files in the report's optional attachments folder

ReportDirectory

FString FGenericErrorReport::ReportDirectory

protected

Full path to the directory the report files are in

ReportFilenames

TArray<FString> FGenericErrorReport::ReportFilenames

protected

List of leaf filenames of all the files in the report folder

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/CrashReportCore/Public/GenericErrorReport.h
• Engine/Source/Runtime/CrashReportCore/Private/GenericErrorReport.cpp