Navigation
API > API/Runtime > API/Runtime/XmlParser
Class representing an XML file
| Name | FXmlFile |
| Type | class |
| Header File | /Engine/Source/Runtime/XmlParser/Public/XmlFile.h |
| Include Path | #include "XmlFile.h" |
Syntax
class FXmlFile
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FXmlFile
(
const FString& InFile, |
Constructs the file with the passed path. | XmlFile.h | |
| XmlFile.h | |||
FXmlFile () |
Constructs the file without a path | XmlFile.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FXmlFile() |
XmlFile.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bCreationFailed | bool | Flag for whether the node creation process failed or not | XmlFile.h | |
| bFileLoaded | bool | Flag for whether a file is loaded or not | XmlFile.h | |
| bHackAttemptToPreserveWhitespace | bool | Flag for the whitespace hack used in the crash report client | XmlFile.h | |
| ErrorMessage | FString | An error message generated on errors to return to the client | XmlFile.h | |
| LoadedFile | FString | The passed-in path of the loaded file (might be absolute or relative) | XmlFile.h | |
| RootNode | FXmlNode * | A pointer to the root node | XmlFile.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Clear () |
Clears the file of all internals. | XmlFile.h | |
| Turns on a specific hack that is only used by the crash report client in order to retain newlines for callstacks. | XmlFile.h | ||
FString GetLastError() |
Gets the last error message from the class | XmlFile.h | |
FXmlNode * GetRootNode () |
Returns the root node of the loaded file. | XmlFile.h | |
const FXmlNode * GetRootNode () |
Returns the root node of the loaded file. | XmlFile.h | |
bool IsValid() |
Checks to see if a file is loaded | XmlFile.h | |
bool LoadFile
(
const FString& Path, |
Loads the file with the passed path. | XmlFile.h | |
bool Save
(
const FString& Path |
Write to disk, UTF-16 format only at the moment | XmlFile.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void AddAttribute
(
const FString& InToken, |
Add an attribute to the passed-in array. | XmlFile.h | |
static void WriteNodeHierarchy
(
const FXmlNode& Node, |
Writes a node hierarchy at the given root to a string | XmlFile.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| XmlFile.h |