UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Member Functions | List of all members
FSinglePropertyConfigHelper Class Reference

Public Member Functions

 FSinglePropertyConfigHelper (const FString &InIniFilename, const FString &InSectionName, const FString &InPropertyName, const TOptional< FString > &InPropertyValue)
 
 FSinglePropertyConfigHelper (const FString &InIniFilename, const FString &InSectionName, const FString &InPropertyName, FConfigCommandStreamSection *InLayerSection)
 
bool UpdateConfigFile ()
 

Detailed Description

Functionality to assist with updating a config file with one property value change.

Constructor & Destructor Documentation

◆ FSinglePropertyConfigHelper() [1/2]

FSinglePropertyConfigHelper::FSinglePropertyConfigHelper ( const FString &  InIniFilename,
const FString &  InSectionName,
const FString &  InPropertyName,
const TOptional< FString > &  InPropertyValue 
)
inline

We need certain information for the helper to be useful.

@Param InIniFilename - The disk location of the file we wish to edit. @Param InSectionName - The section the property belongs to. @Param InPropertyName - The name of the property that has been edited. @Param InPropertyValue - The new value of the property that has been edited, or unset to remove the property.

◆ FSinglePropertyConfigHelper() [2/2]

FSinglePropertyConfigHelper::FSinglePropertyConfigHelper ( const FString &  InIniFilename,
const FString &  InSectionName,
const FString &  InPropertyName,
FConfigCommandStreamSection *  InLayerSection 
)
inline

Setup this helper for writing a property to a static layer section (see ModifyAndWriteLayer)

@Param InIniFilename - The disk location of the file we wish to edit. @Param InSectionName - The section the property belongs to. @Param InPropertyName - The name of the property that has been edited. @Param InLayerSection - The section of a static layer that contains the value(s) to write out (needed to write arrays correctly)

Member Function Documentation

◆ UpdateConfigFile()

bool FSinglePropertyConfigHelper::UpdateConfigFile ( )
inline

Perform the action of updating the config file with the new property value.

The documentation for this class was generated from the following file: