Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter NineDialog Functions (continued)

CheckboxGetText Function

Overview

The CheckboxGetText function retrieves the text (legend or caption) of a checkbox or radio button control group.

Syntax/Parameters

Syntax

string = CheckboxGetText ( int id );

Parameters

id

An int that identifies the dialog checkbox or radio button group whose text will be returned.

Return Value

Returns a string containing the text of the control specified by id or an empty string on failure or if the button has no text. Use the GetLastError function to retrieve error information.

Remarks

This function retrieves the underlying window text for the control. Because an empty string does not necessarily indicate a failure, the GetLastError function should be used to determine if an error occurred. If the id parameter contains an invalid control ID for the open dialog, the GetLastError function will return ERROR_RANGE. If no dialog is open, the GetLastError function will return ERROR_INVALID_HANDLE.

Related Functions

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic