FBuildOutput | Unreal Engine 5.7 Documentation

A build output is an immutable container of values, messages, and logs produced by a build.

The output will not contain any values if it has any errors.

The output can be requested without data, which means that the values will have null data.


Name	FBuildOutput
Type	class
Header File	/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildOutput.h
Include Path	#include "DerivedDataBuildOutput.h"

Syntax

class FBuildOutput

Name	Remarks	Include Path	Unreal Specifiers
FBuildOutput ( Private::IBuildOutputInternal* InOutput )		DerivedDataBuildOutput.h

Name	Type	Remarks	Include Path	Unreal Specifiers
Output	TRefCountPtr< Private::IBuildOutputInternal >		DerivedDataBuildOutput.h

Name	Remarks	Include Path
bool FindMeta ( FUtf8StringView Key, FCbField& OutMeta ) const	Finds the metadata matching the key. Returns true if found.	DerivedDataBuildOutput.h
const FUtf8SharedString & GetFunction()	Returns the name of the build function that produced this output.	DerivedDataBuildOutput.h
TConstArrayView< FBuildOutputLog > GetLogs()	Returns the logs in the order that they were recorded.	DerivedDataBuildOutput.h
TConstArrayView< FBuildOutputMessage > GetMessages()	Returns the messages in the order that they were recorded.	DerivedDataBuildOutput.h
const FCbObject & GetMeta()	Returns the optional metadata.	DerivedDataBuildOutput.h
const FSharedString & GetName()	Returns the name by which to identify this output for logging and profiling.	DerivedDataBuildOutput.h
const FValueWithId & GetValue ( const FValueId& Id ) const	Returns the value matching the ID. Null if no match. Buffer is null if skipped.	DerivedDataBuildOutput.h
TConstArrayView< FValueWithId > GetValues()	Returns the values in the output in order by ID.	DerivedDataBuildOutput.h
bool HasError()	Returns whether the output has any errors.	DerivedDataBuildOutput.h
bool HasLogs()	Returns whether the output has any logs.	DerivedDataBuildOutput.h
void Save ( FCbWriter& Writer ) const	Saves the build output to a compact binary object with values as attachments.	DerivedDataBuildOutput.h
void Save ( FCacheRecordBuilder& RecordBuilder ) const	Saves the build output to a cache record.	DerivedDataBuildOutput.h

Name	Remarks	Include Path	Unreal Specifiers
static FOptionalBuildOutput Load ( const FSharedString& Name, const FUtf8SharedString& Function, const FCbObject& Output )	Load a build output.	DerivedDataBuildOutput.h
static FOptionalBuildOutput Load ( const FSharedString& Name, const FUtf8SharedString& Function, const FCacheRecord& Output )		DerivedDataBuildOutput.h