GET_ATT_SUBSTR

Use the GET_ATT_SUBSTR script function to retrieve a portion of the message text of a Notification object. This function can only be used on the Process page of the relevant Notification object.

Note: If a :PUT_ATT_APPEND statement is used before this function, the portion is taken from the extended message text. For more information, see :PUT_ATT_APPEND.

Syntax

GET_ATT_SUBSTR (CALL_TEXT, Begin, Length)

Parameters

Parameter Description Format Allowed Values
CALL_TEXT Name of the attribute to read from AE name or script variable CALL_TEXT
Begin

Start position for reading.

With UTF-8, this refers to the character position, not the byte position. For example, a value of 7 specifies the 7th character, not necessarily the 7th byte.

Number or script variable n.a.
Length

Number of characters to read.

With UTF-8, this refers to the number of characters, not bytes. For example, a value of 10 specifies 10 characters, which may span more than 10 bytes. Starting with v11, specifying a length greater than the actual length of the message text produces an error.

Number or script variable n.a.

Return Codes

Return Value Condition
Text The specified portion of the message text
" " The specified area does not lie within the message text

Examples

The following example reads the first 20 characters of the message text.

: SET &SECTION# = GET_ATT_SUBSTR (CALL_TEXT,1,20)

See also: