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 > FCbValue

Light Theme

Dark Theme

FCbValue

A type that provides unchecked access to compact binary values.

Choose your operating system:

Windows

macOS

Linux

References

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

Syntax

class FCbValue

Remarks

A type that provides unchecked access to compact binary values.

The main purpose of the type is to efficiently switch on field type. For every other use case, prefer to use the field, array, and object types directly. The accessors here do not check the type before reading the value, which means they can read out of bounds even on a valid compact binary value if the wrong accessor is used.

Constructors

	Name	Description
	FCbValue ( ECbFieldType Type, const void* Value )

Functions

	Name	Description
FCbArrayView	AsArrayView()
FIoHash	AsAttachment()
FMemoryView	AsBinary()
FIoHash	AsBinaryAttachment()
bool	AsBool()
FCbCustomByI...	AsCustomById()
FCbCustomByN...	AsCustomByName()
int64	AsDateTimeTicks()
float	AsFloat32()
double	AsFloat64()
FIoHash	AsHash()
uint64	AsInteger ( UE::CompactBinary::Private::FIntege..., ECbFieldError* OutError, uint64 Default )	Access as an integer, with both positive and negative values returned as unsigned.
int64	AsIntegerNegative()
uint64	AsIntegerPositive()
FIoHash	AsObjectAttachment()
FCbObjectId	AsObjectId()
FCbObjectVie...	AsObjectView()
FUtf8StringV...	AsString ( ECbFieldError* OutError, FUtf8StringView Default )	Access as a string. Checks for range errors and uses the default if OutError is not null.
int64	AsTimeSpanTicks()
FGuid	AsUuid()
const void &...	GetData()
ECbFieldType	GetType()