Navigation
API > API/Runtime > API/Runtime/Core
Record of a log event.
| Name | FLogRecord |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/Logging/StructuredLog.h |
| Include Path | #include "Logging/StructuredLog.h" |
Syntax
class FLogRecord
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Category | FName | Logging/StructuredLog.h | ||
| Fields | FCbObject | Logging/StructuredLog.h | ||
| File | const ANSICHAR * | Logging/StructuredLog.h | ||
| Format | const TCHAR * | Logging/StructuredLog.h | ||
| Line | int32 | Logging/StructuredLog.h | ||
| Template | const FLogTemplate * | Logging/StructuredLog.h | ||
| TextKey | const TCHAR * | Logging/StructuredLog.h | ||
| TextNamespace | const TCHAR * | Logging/StructuredLog.h | ||
| Time | FLogTime | Logging/StructuredLog.h | ||
| Verbosity | ELogVerbosity::Type | Logging/StructuredLog.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ConvertToCommonLog
(
FUtf8StringBuilderBase& OutFormat, |
Converts this record into a common format string and compatible fields. | Logging/StructuredLog.h | |
void FormatMessageTo
(
FUtf8StringBuilderBase& Out |
Formats the message using the format, template, and fields. | Logging/StructuredLog.h | |
void FormatMessageTo
(
FWideStringBuilderBase& Out |
Logging/StructuredLog.h | ||
const FName & GetCategory() |
The optional name of the category for the log record. None when omitted. | Logging/StructuredLog.h | |
const FCbObject & GetFields() |
The fields referenced by the format string, along with optional additional fields. | Logging/StructuredLog.h | |
const ANSICHAR * GetFile() |
The optional source file path for the code that created the log record. Null when omitted. | Logging/StructuredLog.h | |
const TCHAR * GetFormat () |
The format string that serves as the message for the log record. | Logging/StructuredLog.h | |
int32 GetLine() |
The optional source line number for the code that created the log record. 0 when omitted. | Logging/StructuredLog.h | |
const FLogTemplate * GetTemplate() |
The optional template for the format string. | Logging/StructuredLog.h | |
const TCHAR * GetTextKey() |
The key of the localized text. Null when non-localized. | Logging/StructuredLog.h | |
const TCHAR * GetTextNamespace() |
The namespace of the localized text. Null when non-localized. | Logging/StructuredLog.h | |
const FLogTime & GetTime() |
The time at which the log record was created. | Logging/StructuredLog.h | |
ELogVerbosity::Type GetVerbosity() |
The verbosity level of the log record. Must be a valid level with no flags or special values. | Logging/StructuredLog.h | |
void SetCategory
(
const FName& InCategory |
Logging/StructuredLog.h | ||
void SetFields
(
FCbObject&& InFields |
Logging/StructuredLog.h | ||
void SetFile
(
const ANSICHAR* InFile |
Logging/StructuredLog.h | ||
void SetFormat
(
const TCHAR* InFormat |
Logging/StructuredLog.h | ||
void SetLine
(
int32 InLine |
Logging/StructuredLog.h | ||
void SetTemplate
(
const FLogTemplate* InTemplate |
Logging/StructuredLog.h | ||
void SetTextKey
(
const TCHAR* InTextKey |
Logging/StructuredLog.h | ||
void SetTextNamespace
(
const TCHAR* InTextNamespace |
Logging/StructuredLog.h | ||
void SetTime
(
const FLogTime& InTime |
Logging/StructuredLog.h | ||
void SetVerbosity
(
ELogVerbosity::Type InVerbosity |
Logging/StructuredLog.h |