FName::IsValidXName

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

Choose your operating system:

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 FName 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").