Terminal Emulator - RTE Vuser Functions (TE) > Alphabetical List of Functions > TE_send_text

TE_send_text

Example: TE_send_text Send Text Functions

Sends a null-terminated string to a VT terminal emulator.

int TE_send_text( const char * text );

Inputs

text A null terminated text.

TE_send_text sends text to a terminal emulator in VT emulation mode. Nonprintable characters are specified by hexadecimal codes.

Specify nonprintable characters with escaped hexadecimal codes. For example, pass <Escape> as \x1b. To insert a literal backslash, escape it with another backslash: '\\'.

If the text contains brackets that delimit a parameter (by default, '{' and }'), the runtime environment checks if the text between the brackets is the name of an existing parameter. If so, the {param_name} sting is replaced by the value of the parameter. If no such parameter exists, the text, including the brackets, is sent exactly as entered.

Return Values

This function returns 0 if it succeeds, and a negative error code if it fails. It also sets the global variable TE_errno.

Parameterization

You cannot use standard parameterization for any arguments in this function.