FManifestUpdateHelper

This is a utility class used to update individual sections of an XML manifest or .plist in raw string form.

Windows
MacOS
Linux

References

Module

SharedSettingsWidgets

Header

/Engine/Source/Developer/SharedSettingsWidgets/Public/ManifestUpdateHelper.h

Include

#include "ManifestUpdateHelper.h"

Syntax

class FManifestUpdateHelper

Remarks

This is a utility class used to update individual sections of an XML manifest or .plist in raw string form. It is formatting sensitive and will fail if things are formatted in an unexpected manner. This is a stopgap measure, and will be replaced using a proper XML parser when it is ready for use.

Constructors

Name Description

Public function

FManifestUpdateHelper

(
    const FString& InFilename
)

Functions

Name Description

Public function

bool

 

Finalize

(
    const FString& TargetFilename,
    bool bShowNotifyOnFailure,
    FFileHelper::EEncodingOptions Encod...
)

Finalizes the updater, and writes it back to the file, returning true if successful, and false if there were any errors.

Public function Const

FText

 

GetFirstErrorMessage()

Returns the first error message.

Public function

bool

 

HasKey

(
    const FString& MatchPrefix
)

Checks if a key exists matching MatchPrefix.

Public function

void

 

ReplaceKey

(
    const FString& MatchPrefix,
    const FString& MatchSuffix,
    const FString& NewInfix
)

Replace a key in the manifest (between MatchPrefix and MatchSuffix) with NewInfix.

Public function Static

bool

 

ReplaceStringPortion

(
    FString& InOutString,
    const FString& MatchPrefix,
    const FString& MatchSuffix,
    const FString& NewInfix
)

Replaces the text in InOutString between MatchPrefix and MatchSuffix with NewInfix, returning true if it was found.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback