IProjectManager::SignSampleProject

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

Choose your operating system:

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.