Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter NineDialog Functions (continued)

EditSetText Function

Overview

The EditSetText function sets an edit control’s text with a string or integer.

Syntax/Parameters

Syntax

int = EditSetText ( int id, mixed data, [parameters ... ]);

Parameters

id

An int containing the control ID of an edit or static control.

data

A string or wstring 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

Though the EditGetText function is intended for use with edit controls, it will actually work on most control classes. Note that list boxes do not display their window titles (which contains the text).

The EditSetText function 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 formats 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.

If a string type parameter is used, the encoding is assumed to ANSI. If wstring type parameter is used, then Unicode is expected.

Related Functions

Platform Support

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

Legato IDE, Legato Basic