guiTextBoxGetText (Function)

Top  Previous  Next

Architecture:

NX32L

Device support:

NX-400

Firmware version:

1.00.00


This function retrieves the text from a text box.

 

Input:

text_box : SYSHANDLE

A handle to the text box to get the text from.

 

Output:

text : STRING

The text in the text box.

 

Returns: INT

0

- Success.

-1

- Interface is not open (see guiOpen).

-3

- Invalid handle.

-8

- The text contains invalid characters.

-11

- The GUI API is not supported.

 

Declaration:

FUNCTION guiTextBoxGetText : INT;
VAR_INPUT
  text_box : SYSHANDLE;
  text     : ACCESS STRING;
END_VAR;

 

 

Example:

INCLUDE rtcu.inc
 
PROGRAM test;
VAR
  rc       : INT;
  text     : STRING;
  text_box : SYSHANDLE;
END_VAR;
 
BEGIN
  ...
  // Read the text
  rc := guiTextBoxGetText(text_box := text_box, text:=text);
  ...
END;
END_PROGRAM;