Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter NineDialog Functions (continued)

StaticControlSetText Function

Overview

The StaticControlSetText function sets text in a static control text as a string or integer.

Syntax/Parameters

Syntax

int = StaticControlSetText ( int id, mixed data, [patameters ... ]);

Parameters

id

An int containing the control ID of a static control.

value

A string as a display string or a format string; or

an int value to enter into the edit control. If an int is supplied, parameters is not allowed.

parameters

Zero or more parameters to be formatted and inserted into value. If no parameters are supplied, message is simply passed through to the result string.

Return Value

Returns an int as ERROR_NONE or a formatted error code on failure, ERROR_RANGE if id is an invalid control ID for the open dialog, or ERROR_INVALID_HANDLE if no dialog is open. Use the GetLastError function to retrieve error information. 

Remarks

The StaticControlSetText EditGetText Functionfunction is intended for use with static controls. Addressing a different control class will result in an error.

StaticControlSetText permits the usage of a formatted string to display information. Formatted strings allow numeric and other data to be formatted into a string for appropriate display. The format of the string and the data to be inserted depend upon the structure of the value parameter and the contents of the additional parameters passed to the function. See Section 5.2 String Functions for information on creating formatted strings.

Related Functions

Platform Support

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

Legato IDE, Legato Basic