FArchiveFileWriterGeneric

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/HAL/FileManagerGeneric.h

Include

#include "HAL/FileManagerGeneric.h"

Syntax

class FArchiveFileWriterGeneric : public FArchive

Variables

Name Description

Protected variable

bool

 

bLoggingError

Protected variable

TArray64< uint8...

 

BufferArray

Protected variable

int64

 

BufferSize

Protected variable

FString

 

Filename

Filename for debugging purposes

Protected variable

uint32

 

Flags

Protected variable

TUniquePtr< IFi...

 

Handle

Protected variable

int64

 

Pos

Constructors

Name Description

Public function

FArchiveFileWriterGeneric

(
    IFileHandle* InHandle,
    const TCHAR* InFilename,
    int64 InPos,
    uint32 InBufferSize,
    uint32 InFlags
)

Destructors

Name Description

Public function

~FArchiveFileWriterGeneric()

Functions

Name Description

Protected function Virtual

bool

 

CloseLowLevel()

Close the file handle

Protected function

bool

 

FlushBuffer()

Write any internal buffer to the file handle @note Doesn't flush the handle itself, so this data may be cached by the OS and not yet written to disk!

Protected function Const

bool

 

IsSilent()

Returns true if the archive should suppress logging in case of error

Protected function

void

 

LogWriteError

(
    const TCHAR* Message
)

Logs I/O error It is important to not call any platform API functions after the error occurred and before calling this functions as the system error code may get reset and will not be properly logged in this message.

Protected function Virtual

bool

 

SeekLowLevel

(
    int64 InPos
)

Platform specific seek

Protected function Virtual

bool

 

WriteLowLevel

(
    const uint8* Src,
    int64 CountToWrite
)

Platform specific write

Overridden from FArchive

Name Description

Public function Virtual

bool

 

Close()

Attempts to close and finalize any handles used for backing data storage, returns true if it succeeded.

Public function Virtual

void

 

Flush()

Attempts to finish writing any buffered data to disk/permanent storage.

Public function Virtual

void

 

Seek

(
    int64 InPos
)

Attempts to set the current offset into backing data storage, this will do nothing if there is no storage.

Public function Virtual

void

 

Serialize

(
    void* V,
    int64 Length
)

Overridden from FArchiveState

Name Description

Public function Virtual Const

FString

 

GetArchiveName()

Returns the name of the Archive.

Public function Virtual

int64

 

Tell()

Returns the current location within the backing data storage, which can possibly be passed to Seek later to restore a read/write location.

Public function Virtual

int64

 

TotalSize()

Returns total size of the backing data storage.