cns_checkName

Checks whether the given display name is valid.

Synopsis

int cns_checkName(langString text);

Parameters

Parameter Description
text Display name which is checked

Return value

Possible return values:

  • 0 => Valid name

  • -1 => Invalid name

  • -2 => In case of invalid characters. The list of invalid characters can be found within the documentation of the function namecheck().

Errors

Possible errors:

  • The name contains invalid characters

Description

This function checks if the given display name is valid.

main()
{
  DebugN(cns_checkName("MyName")); //Output: 0
  DebugN(cns_checkName("M<Na!.:")); //Output: -1
}

Availability

UI, CTRL