FPakFileHandle

File handle to read from pak file.

Inheritance Hierarchy

IFileHandle

FPakFileHandle

References

Module

PakFile

Header

/Engine/Source/Runtime/PakFile/Public/IPlatformFilePak.h

Include

#include "IPlatformFilePak.h"

Syntax

template<typename ReaderPolicy>
class FPakFileHandle : public IFileHandle

Remarks

File handle to read from pak file.

Constructors

Name Description

Public function

FPakFileHandle

(
    const FPakFile& InPakFile,
    const FPakEntry& InPakEntry,
    TAcquirePakReaderFunction& InAcqui...
)

Use constructor that takes a TRefCountPtr instead

Public function

FPakFileHandle

(
    const TRefCountPtr< const FPakFile ...,
    const FPakEntry& InPakEntry,
    TAcquirePakReaderFunction& InAcqui...
)

Constructs pak file handle to read from pak.

Public function

FPakFileHandle

(
    const FPakFile& InPakFile,
    const FPakEntry& InPakEntry,
    FArchive* InPakReader
)

Use constructor that takes a TRefCountPtr instead

Public function

FPakFileHandle

(
    const TRefCountPtr< const FPakFile ...,
    const FPakEntry& InPakEntry,
    FArchive* InPakReader
)

Constructs pak file handle to read from pak.

Destructors

Name Description

Public function Virtual

~FPakFileHandle()

  1. Cleans up the reader archive if necessary.

Overridden from IFileHandle

Name Description

Public function Virtual

bool

 

Flush

(
    const bool bFullFlush
)

Flushes file handle to disk.

Public function Virtual

bool

 

Read

(
    uint8* Destination,
    int64 BytesToRead
)

Read bytes from the file.

Public function Virtual

bool

 

Seek

(
    int64 NewPosition
)

Change the current write or read position.

Public function Virtual

bool

 

SeekFromEnd

(
    int64 NewPositionRelativeToEnd
)

Change the current write or read position, relative to the end of the file.

Public function Virtual

int64

 

Size()

Return the total size of the file

Public function Virtual

int64

 

Tell()

Return the current write or read position.

Public function Virtual

bool

 

Truncate

(
    int64 NewSize
)

Truncate the file to the given size (in bytes).

Public function Virtual

bool

 

Write

(
    const uint8* Source,
    int64 BytesToWrite
)

Write bytes to the file.

Deprecated Functions

Name Description

Public function

 

FPakFileHandle

(
    const FPakFile& InPakFile,
    const FPakEntry& InPakEntry,
    TAcquirePakReaderFunction& InAcqui...
)

Use constructor that takes a TRefCountPtr instead

Public function

 

FPakFileHandle

(
    const FPakFile& InPakFile,
    const FPakEntry& InPakEntry,
    FArchive* InPakReader
)

Use constructor that takes a TRefCountPtr instead
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Cancel