UE::UniversalObjectLocator::FParseStringResult Struct Reference

#include <UniversalObjectLocatorStringParams.h>

Public Member Functions
	operator bool () const
FParseStringResult &	Success (int32 AdditionalNumCharsParsed=0)
FParseStringResult &	Failure (const FText &InFailureText)
UNIVERSALOBJECTLOCATOR_API FStringView	Progress (FStringView CurrentString, int32 NumToProgress)

Public Attributes
FText	ErrorMessage
int32	NumCharsParsed = 0
bool	bSuccess = false

Detailed Description

String parse result structure, specfying success/failure, number of characters that were parsed, and any error information.

Member Function Documentation

Failure()

FParseStringResult & UE::UniversalObjectLocator::FParseStringResult::Failure ( const FText &  InFailureText )

inline

operator bool()

UE::UniversalObjectLocator::FParseStringResult::operator bool ( ) const

inlineexplicit

Progress()

FStringView UE::UniversalObjectLocator::FParseStringResult::Progress	(	FStringView	CurrentString,
		int32	NumToProgress
	)

Success()

FParseStringResult & UE::UniversalObjectLocator::FParseStringResult::Success ( int32  AdditionalNumCharsParsed = 0 )

inline

Member Data Documentation

bSuccess

bool UE::UniversalObjectLocator::FParseStringResult::bSuccess = false

Whether parsing was successful or not

ErrorMessage

FText UE::UniversalObjectLocator::FParseStringResult::ErrorMessage

Optional error message, only populated when FParseStringParams::bWantsErrorMessaging is true

NumCharsParsed

int32 UE::UniversalObjectLocator::FParseStringResult::NumCharsParsed = 0

The number of characters that were parsed. On Success this indicates the last character that resulted in the successful parse, on failure, this may be 0, or the point at which parsing finished

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/UniversalObjectLocator/Public/UniversalObjectLocatorStringParams.h
• Engine/Source/Runtime/UniversalObjectLocator/Private/UniversalObjectLocatorStringParams.cpp