FName::IsValidXName

Checks to see that a given name-like string follows the rules that Unreal requires.

Windows
MacOS
Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/UObject/NameTypes.h

Include

#include "UObject/NameTypes.h"

Source

/Engine/Source/Runtime/Core/Private/UObject/UnrealNames.cpp

Syntax

static bool IsValidXName
(
    const FString & InName,
    const FString & InInvalidChars,
    FText * OutReason,
    const FText * InErrorCtx
)

Remarks

Checks to see that a given name-like string follows the rules that Unreal requires.

Returns

true if the name is valid

Parameters

Parameter

Description

InName

String containing the name to test.

InInvalidChars

The set of invalid characters that the name cannot contain.

OutReason

If the check fails, this string is filled in with the reason why.

InErrorCtx

Error context information to show in the error message (default is "Name").

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