1. Epic GamesDeveloper
  3. LoadFromCompactBinary

LoadFromCompactBinary

Function Overloads

API > API/Runtime > API/Runtime/Core

Overloads

Name Remarks Include Path Unreal Specifiers

bool LoadFromCompactBinary ( FCbFieldView Field,
TTuple< Types... >& Tuple
)

   Serialization/CompactBinaryContainerSerialization.h  

bool LoadFromCompactBinary ( FCbFieldView Field,
FUtf8StringBuilderBase& OutValue
)

 LoadFromCompactBinary attempts to load the output value from compact binary. Serialization/CompactBinarySerialization.h  

bool LoadFromCompactBinary ( FCbFieldView Field,
FWideStringBuilderBase& OutValue
)

   Serialization/CompactBinarySerialization.h  

bool LoadFromCompactBinary ( FCbFieldView Field,
UE::FUtf8SharedString& OutString
)

   Serialization/CompactBinarySerialization.h  

bool LoadFromCompactBinary ( FCbFieldView Field,
UE::FWideSharedString& OutString
)

   Serialization/CompactBinarySerialization.h  

bool LoadFromCompactBinary ( FCbFieldView Field,
FUtf8String& OutValue
)

   Serialization/CompactBinarySerialization.h  

bool LoadFromCompactBinary ( FCbFieldView Field,
FWideString& OutValue
)

   Serialization/CompactBinarySerialization.h  

bool LoadFromCompactBinary ( FCbFieldView Field,
FName& OutValue
)

   Serialization/CompactBinarySerialization.h  

bool LoadFromCompactBinary ( FCbFieldView Field,
FGuid& OutValue
)

   Serialization/CompactBinarySerialization.h  

bool LoadFromCompactBinary ( FCbFieldView Field,
FDateTime& OutValue
)

   Serialization/CompactBinarySerialization.h  

bool LoadFromCompactBinary ( FCbFieldView Field,
TArray< T, Allocator >& OutValue
)

   Serialization/CompactBinarySerialization.h  

bool LoadFromCompactBinary ( FCbFieldView Field,
int8& OutValue,
const int8 Default
)

   Serialization/CompactBinarySerialization.h  

bool LoadFromCompactBinary ( FCbFieldView Field,
int16& OutValue,
const int16 Default
)

   Serialization/CompactBinarySerialization.h  

bool LoadFromCompactBinary ( FCbFieldView Field,
int32& OutValue,
const int32 Default
)

   Serialization/CompactBinarySerialization.h  

bool LoadFromCompactBinary ( FCbFieldView Field,
int64& OutValue,
const int64 Default
)

   Serialization/CompactBinarySerialization.h  

bool LoadFromCompactBinary ( FCbFieldView Field,
uint8& OutValue,
const uint8 Default
)

   Serialization/CompactBinarySerialization.h  

bool LoadFromCompactBinary ( FCbFieldView Field,
uint16& OutValue,
const uint16 Default
)

   Serialization/CompactBinarySerialization.h  

bool LoadFromCompactBinary ( FCbFieldView Field,
uint32& OutValue,
const uint32 Default
)

   Serialization/CompactBinarySerialization.h  

bool LoadFromCompactBinary ( FCbFieldView Field,
uint64& OutValue,
const uint64 Default
)

   Serialization/CompactBinarySerialization.h  

bool LoadFromCompactBinary ( FCbFieldView Field,
float& OutValue,
const float Default
)

   Serialization/CompactBinarySerialization.h  

bool LoadFromCompactBinary ( FCbFieldView Field,
double& OutValue,
const double Default
)

   Serialization/CompactBinarySerialization.h  

bool LoadFromCompactBinary ( FCbFieldView Field,
bool& OutValue,
const bool Default
)

   Serialization/CompactBinarySerialization.h  

bool LoadFromCompactBinary ( FCbFieldView Field,
FIoHash& OutValue,
const FIoHash& Default
)

   Serialization/CompactBinarySerialization.h  

bool LoadFromCompactBinary ( FCbFieldView Field,
FGuid& OutValue,
const FGuid& Default
)

   Serialization/CompactBinarySerialization.h  

bool LoadFromCompactBinary ( FCbFieldView Field,
FDateTime& OutValue,
FDateTime Default
)

   Serialization/CompactBinarySerialization.h  

bool LoadFromCompactBinary ( FCbFieldView Field,
FCbObjectId& OutValue,
const FCbObjectId& Default
)

   Serialization/CompactBinarySerialization.h  

LoadFromCompactBinary(FCbFieldView, TTuple< Types... > &)

   
Name LoadFromCompactBinary
Type function
Header File /Engine/Source/Runtime/Core/Public/Serialization/CompactBinaryContainerSerialization.h
Include Path #include "Serialization/CompactBinaryContainerSerialization.h" 
template<typename... Types>  
bool LoadFromCompactBinary  
(  
    FCbFieldView Field,  
    TTuple < Types... > & Tuple  
)

LoadFromCompactBinary(FCbFieldView, FUtf8StringBuilderBase &)

Description

LoadFromCompactBinary attempts to load the output value from compact binary.

Implementations of LoadCompactBinary are expected to assign the output even on failure. Implementations may accept an optional default value to assign in case of load failure.

   
Name LoadFromCompactBinary
Type function
Header File /Engine/Source/Runtime/Core/Public/Serialization/CompactBinarySerialization.h
Include Path #include "Serialization/CompactBinarySerialization.h"
Source /Engine/Source/Runtime/Core/Private/Serialization/CompactBinarySerialization.cpp 
bool LoadFromCompactBinary  
(  
    FCbFieldView Field,  
    FUtf8StringBuilderBase & OutValue  
)

true if required fields had the values with the correct type and range, otherwise false.

LoadFromCompactBinary(FCbFieldView, FWideStringBuilderBase &)

   
Name LoadFromCompactBinary
Type function
Header File /Engine/Source/Runtime/Core/Public/Serialization/CompactBinarySerialization.h
Include Path #include "Serialization/CompactBinarySerialization.h"
Source /Engine/Source/Runtime/Core/Private/Serialization/CompactBinarySerialization.cpp 
bool LoadFromCompactBinary  
(  
    FCbFieldView Field,  
    FWideStringBuilderBase & OutValue  
)

LoadFromCompactBinary(FCbFieldView, UE::FUtf8SharedString &)

   
Name LoadFromCompactBinary
Type function
Header File /Engine/Source/Runtime/Core/Public/Serialization/CompactBinarySerialization.h
Include Path #include "Serialization/CompactBinarySerialization.h"
Source /Engine/Source/Runtime/Core/Private/Serialization/CompactBinarySerialization.cpp 
bool LoadFromCompactBinary  
(  
    FCbFieldView Field,  
    UE::FUtf8SharedString & OutString  
)

LoadFromCompactBinary(FCbFieldView, UE::FWideSharedString &)

   
Name LoadFromCompactBinary
Type function
Header File /Engine/Source/Runtime/Core/Public/Serialization/CompactBinarySerialization.h
Include Path #include "Serialization/CompactBinarySerialization.h"
Source /Engine/Source/Runtime/Core/Private/Serialization/CompactBinarySerialization.cpp 
bool LoadFromCompactBinary  
(  
    FCbFieldView Field,  
    UE::FWideSharedString & OutString  
)

LoadFromCompactBinary(FCbFieldView, FUtf8String &)

   
Name LoadFromCompactBinary
Type function
Header File /Engine/Source/Runtime/Core/Public/Serialization/CompactBinarySerialization.h
Include Path #include "Serialization/CompactBinarySerialization.h"
Source /Engine/Source/Runtime/Core/Private/Serialization/CompactBinarySerialization.cpp 
bool LoadFromCompactBinary  
(  
    FCbFieldView Field,  
    FUtf8String & OutValue  
)

LoadFromCompactBinary(FCbFieldView, FWideString &)

   
Name LoadFromCompactBinary
Type function
Header File /Engine/Source/Runtime/Core/Public/Serialization/CompactBinarySerialization.h
Include Path #include "Serialization/CompactBinarySerialization.h"
Source /Engine/Source/Runtime/Core/Private/Serialization/CompactBinarySerialization.cpp 
bool LoadFromCompactBinary  
(  
    FCbFieldView Field,  
    FWideString & OutValue  
)

LoadFromCompactBinary(FCbFieldView, FName &)

   
Name LoadFromCompactBinary
Type function
Header File /Engine/Source/Runtime/Core/Public/Serialization/CompactBinarySerialization.h
Include Path #include "Serialization/CompactBinarySerialization.h"
Source /Engine/Source/Runtime/Core/Private/Serialization/CompactBinarySerialization.cpp 
bool LoadFromCompactBinary  
(  
    FCbFieldView Field,  
    FName & OutValue  
)

LoadFromCompactBinary(FCbFieldView, FGuid &)

   
Name LoadFromCompactBinary
Type function
Header File /Engine/Source/Runtime/Core/Public/Serialization/CompactBinarySerialization.h
Include Path #include "Serialization/CompactBinarySerialization.h"
Source /Engine/Source/Runtime/Core/Private/Serialization/CompactBinarySerialization.cpp 
bool LoadFromCompactBinary  
(  
    FCbFieldView Field,  
    FGuid & OutValue  
)

LoadFromCompactBinary(FCbFieldView, FDateTime &)

   
Name LoadFromCompactBinary
Type function
Header File /Engine/Source/Runtime/Core/Public/Serialization/CompactBinarySerialization.h
Include Path #include "Serialization/CompactBinarySerialization.h"
Source /Engine/Source/Runtime/Core/Private/Serialization/CompactBinarySerialization.cpp 
bool LoadFromCompactBinary  
(  
    FCbFieldView Field,  
    FDateTime & OutValue  
)

LoadFromCompactBinary(FCbFieldView, TArray< T, Allocator > &)

   
Name LoadFromCompactBinary
Type function
Header File /Engine/Source/Runtime/Core/Public/Serialization/CompactBinarySerialization.h
Include Path #include "Serialization/CompactBinarySerialization.h" 
template<typename T, typename Allocator>  
bool LoadFromCompactBinary  
(  
    FCbFieldView Field,  
    TArray < T, Allocator > & OutValue  
)

LoadFromCompactBinary(FCbFieldView, int8 &, const int8)

   
Name LoadFromCompactBinary
Type function
Header File /Engine/Source/Runtime/Core/Public/Serialization/CompactBinarySerialization.h
Include Path #include "Serialization/CompactBinarySerialization.h" 
bool LoadFromCompactBinary  
(  
    FCbFieldView Field,  
    int8 & OutValue,  
    const int8 Default  
)

LoadFromCompactBinary(FCbFieldView, int16 &, const int16)

   
Name LoadFromCompactBinary
Type function
Header File /Engine/Source/Runtime/Core/Public/Serialization/CompactBinarySerialization.h
Include Path #include "Serialization/CompactBinarySerialization.h" 
bool LoadFromCompactBinary  
(  
    FCbFieldView Field,  
    int16 & OutValue,  
    const int16 Default  
)

LoadFromCompactBinary(FCbFieldView, int32 &, const int32)

   
Name LoadFromCompactBinary
Type function
Header File /Engine/Source/Runtime/Core/Public/Serialization/CompactBinarySerialization.h
Include Path #include "Serialization/CompactBinarySerialization.h" 
bool LoadFromCompactBinary  
(  
    FCbFieldView Field,  
    int32 & OutValue,  
    const int32 Default  
)

LoadFromCompactBinary(FCbFieldView, int64 &, const int64)

   
Name LoadFromCompactBinary
Type function
Header File /Engine/Source/Runtime/Core/Public/Serialization/CompactBinarySerialization.h
Include Path #include "Serialization/CompactBinarySerialization.h" 
bool LoadFromCompactBinary  
(  
    FCbFieldView Field,  
    int64 & OutValue,  
    const int64 Default  
)

LoadFromCompactBinary(FCbFieldView, uint8 &, const uint8)

   
Name LoadFromCompactBinary
Type function
Header File /Engine/Source/Runtime/Core/Public/Serialization/CompactBinarySerialization.h
Include Path #include "Serialization/CompactBinarySerialization.h" 
bool LoadFromCompactBinary  
(  
    FCbFieldView Field,  
    uint8 & OutValue,  
    const uint8 Default  
)

LoadFromCompactBinary(FCbFieldView, uint16 &, const uint16)

   
Name LoadFromCompactBinary
Type function
Header File /Engine/Source/Runtime/Core/Public/Serialization/CompactBinarySerialization.h
Include Path #include "Serialization/CompactBinarySerialization.h" 
bool LoadFromCompactBinary  
(  
    FCbFieldView Field,  
    uint16 & OutValue,  
    const uint16 Default  
)

LoadFromCompactBinary(FCbFieldView, uint32 &, const uint32)

   
Name LoadFromCompactBinary
Type function
Header File /Engine/Source/Runtime/Core/Public/Serialization/CompactBinarySerialization.h
Include Path #include "Serialization/CompactBinarySerialization.h" 
bool LoadFromCompactBinary  
(  
    FCbFieldView Field,  
    uint32 & OutValue,  
    const uint32 Default  
)

LoadFromCompactBinary(FCbFieldView, uint64 &, const uint64)

   
Name LoadFromCompactBinary
Type function
Header File /Engine/Source/Runtime/Core/Public/Serialization/CompactBinarySerialization.h
Include Path #include "Serialization/CompactBinarySerialization.h" 
bool LoadFromCompactBinary  
(  
    FCbFieldView Field,  
    uint64 & OutValue,  
    const uint64 Default  
)

LoadFromCompactBinary(FCbFieldView, float &, const float)

   
Name LoadFromCompactBinary
Type function
Header File /Engine/Source/Runtime/Core/Public/Serialization/CompactBinarySerialization.h
Include Path #include "Serialization/CompactBinarySerialization.h" 
bool LoadFromCompactBinary  
(  
    FCbFieldView Field,  
    float & OutValue,  
    const float Default  
)

LoadFromCompactBinary(FCbFieldView, double &, const double)

   
Name LoadFromCompactBinary
Type function
Header File /Engine/Source/Runtime/Core/Public/Serialization/CompactBinarySerialization.h
Include Path #include "Serialization/CompactBinarySerialization.h" 
bool LoadFromCompactBinary  
(  
    FCbFieldView Field,  
    double & OutValue,  
    const double Default  
)

LoadFromCompactBinary(FCbFieldView, bool &, const bool)

   
Name LoadFromCompactBinary
Type function
Header File /Engine/Source/Runtime/Core/Public/Serialization/CompactBinarySerialization.h
Include Path #include "Serialization/CompactBinarySerialization.h" 
bool LoadFromCompactBinary  
(  
    FCbFieldView Field,  
    bool & OutValue,  
    const bool Default  
)

LoadFromCompactBinary(FCbFieldView, FIoHash &, const FIoHash &)

   
Name LoadFromCompactBinary
Type function
Header File /Engine/Source/Runtime/Core/Public/Serialization/CompactBinarySerialization.h
Include Path #include "Serialization/CompactBinarySerialization.h" 
bool LoadFromCompactBinary  
(  
    FCbFieldView Field,  
    FIoHash & OutValue,  
    const FIoHash & Default  
)

LoadFromCompactBinary(FCbFieldView, FGuid &, const FGuid &)

   
Name LoadFromCompactBinary
Type function
Header File /Engine/Source/Runtime/Core/Public/Serialization/CompactBinarySerialization.h
Include Path #include "Serialization/CompactBinarySerialization.h"
Source /Engine/Source/Runtime/Core/Private/Serialization/CompactBinarySerialization.cpp 
bool LoadFromCompactBinary  
(  
    FCbFieldView Field,  
    FGuid & OutValue,  
    const FGuid & Default  
)

LoadFromCompactBinary(FCbFieldView, FDateTime &, FDateTime)

   
Name LoadFromCompactBinary
Type function
Header File /Engine/Source/Runtime/Core/Public/Serialization/CompactBinarySerialization.h
Include Path #include "Serialization/CompactBinarySerialization.h"
Source /Engine/Source/Runtime/Core/Private/Serialization/CompactBinarySerialization.cpp 
bool LoadFromCompactBinary  
(  
    FCbFieldView Field,  
    FDateTime & OutValue,  
    FDateTime Default  
)

LoadFromCompactBinary(FCbFieldView, FCbObjectId &, const FCbObjectId &)

   
Name LoadFromCompactBinary
Type function
Header File /Engine/Source/Runtime/Core/Public/Serialization/CompactBinarySerialization.h
Include Path #include "Serialization/CompactBinarySerialization.h" 
bool LoadFromCompactBinary  
(  
    FCbFieldView Field,  
    FCbObjectId & OutValue,  
    const FCbObjectId & Default  
)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page