Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > Serialization > FStructuredArchive

Light Theme

Dark Theme

FStructuredArchive

Manages the state of an underlying [FStructuredArchiveFormatter](API\Runtime\Core\Serialization\FStructuredArchiveFormatter), and provides a consistent API for reading and writing to a structured archive.

Windows

MacOS

Linux

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/Serialization/StructuredArchive.h
Include	#include "Serialization/StructuredArchive.h"

Syntax

class FStructuredArchive

Remarks

Manages the state of an underlying FStructuredArchiveFormatter, and provides a consistent API for reading and writing to a structured archive.

Both reading and writing to the archive are forward only from an interface point of view. There is no point at which it is possible to require seeking.

Constructors

	Name	Description
	FStructuredArchive ( FArchiveFormatterType& InFormatter )	Constructor.
	FStructuredArchive ( const FStructuredArchive& )

Destructors

	Name	Description
	~FStructuredArchive()	Default destructor. Closes the archive.

Functions

	Name	Description
void	Close()	Flushes any remaining scope to the underlying formatter and closes the archive.
const FArchi...	GetArchiveState()	Gets the archiving state.
FArchive &	GetUnderlyingArchive()	Gets the serialization context from the underlying archive.
FStructuredA...	Open()	Start writing to the archive, and gets an interface to the root slot.

Operators

		Name	Description
	FStructuredA...	operator= ( const FStructuredArchive& )

Classes

	Name	Description
	FContainer

Typedefs

Name	Description
FArray
FMap
FRecord
FSlot
FStream

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss