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 > Projects > Interfaces > IProjectManager > IProjectManager::SignSampleProject

Light Theme

Dark Theme

IProjectManager::SignSampleProject

Sets the project's EpicSampleNameHash (based on its filename) and category, then saves the file to disk.

Windows

MacOS

Linux

References

Module	Projects
Header	/Engine/Source/Runtime/Projects/Public/Interfaces/IProjectManager.h
Include	#include "Interfaces/IProjectManager.h"

Syntax

bool SignSampleProject
(
    const FString & FilePath,
    const FString & Category,
    FText & OutFailReason
)

Remarks

Sets the project's EpicSampleNameHash (based on its filename) and category, then saves the file to disk. This marks the project as a sample and fixes its filename so that it isn't mistaken for a sample if a copy of the file is made.

Returns

true if the file was successfully updated and saved to disk

Parameters

Parameter	Description
FilePath	The filepath where the sample project is stored.
Category	Category to place the sample in
OutFailReason	When returning false, this provides a display reason why the file could not be created.

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

Take our survey

Dismiss