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 > JsonUtilities > FJsonObjectConverter > UStructToJsonObjectString > FJsonObjectConverter::UStructToJsonObjectString

Light Theme

Dark Theme

FJsonObjectConverter::UStructToJsonObjectString

Templated version; Converts from a [UStruct](API\Runtime\CoreUObject\UObject\UStruct) to a json string containing an object, using exportText

Windows

MacOS

Linux

References

Module	JsonUtilities
Header	/Engine/Source/Runtime/JsonUtilities/Public/JsonObjectConverter.h
Include	#include "JsonObjectConverter.h"

Syntax

template<typename InStructType>
static bool UStructToJsonObjectString
(
    const InStructType & InStruct,
    FString & OutJsonString,
    int64 CheckFlags,
    int64 SkipFlags,
    int32 Indent,
    const CustomExportCallback * ExportCb,
    bool bPrettyPrint
)

Remarks

Templated version; Converts from a UStruct to a json string containing an object, using exportText

Returns

False if any properties failed to write

Parameters

Parameter	Description
Struct	The UStruct instance to copy out of
JsonObject	Json Object to be filled in with data from the ustruct
CheckFlags	Only convert properties that match at least one of these flags. If 0 check all properties.
SkipFlags	Skip properties that match any of these flags
Indent	How many tabs to add to the json serializer
ExportCb	Optional callback to override export behavior, if this returns null it will fallback to the default
bPrettyPrint	Option to use pretty print (e.g., adds line endings) or condensed print

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

Take our survey

Dismiss