charCodeAt

The charCodeAt task obtains a Unicode decimal value (UTF-16) for a character at a specific position in a string. UTF-16 is a 16-bit integer between 0 and 65535.

Potential use cases

This task is a character-processing method that returns an encoded value at a specific location, rather than the character itself. You could use charCodeAt to perform string handling with characters you cannot type directly using a keyboard.

This task is also useful for working with strings used in objects such as a Text Field, Context Menu, or File Reference object. For example, if you have an input form with a text field that requires an email address, you could use charCodeAt to build a text validation function in the form control to parse the email address character by character and validate whether the entry is formatted correctly.

Properties

IncomingTypeDescription
strStringRequired. The string to get the character code from.
indexNumberRequired. The position of the character in str that you want to return the Unicode value for. An index of the first character is 0, the second character 1, and so on. If index is not a number, it defaults to 0.
OutgoingTypeDescription
codeNumberThe UTF-16 decimal value that is returned. The task returns NaN if there is no character at the specified index, or if the index is less than 0.

Examples

Example 1

In this example:

  • The reference variable for the incoming str is statically set to Hello World!.
  • The index number is 4.
charCodeAt task with str Hello World! and index 4

Once the workflow is executed, the code value is displayed under the Outgoing tab in Task History, accessed from Jobs in Operations Manager. The character code 111 is equal to the lowercase letter "o".

charCodeAt task output showing code 111 for the letter o

Example 2

In this example:

  • The reference variable for the incoming str is statically set to Hello Krunal Legere.
  • The index number is 5.
charCodeAt task with str Hello Krunal Legere and index 5

The character code that returns is 32, which is equal to a space in the string.

charCodeAt task output showing code 32 for a space character