Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter NineDialog Functions (continued)

DialogGetCaption Function

Overview

The DialogGetCaption function retrieves the caption for the current dialog.

Syntax/Parameters

Syntax

string = DialogGetCaption ( );

Parameters

(none)

 

Return Value

Returns a string containing the dialog’s caption or an empty string on failure. Use the GetLastError function to retrieve error information.

Remarks

For basic dialogs, the caption can be set by editing the dialog resource. The caption can also be adjusted via the DialogSetCaption function. The DialogGetCaption function will return an empty string if the dialog has no caption or if there is no dialog currently open.

This function only operates within a dialog procedure; if it is called outside of a procedure, it will fail.

See also the CAPTION Resource Statement.

Related Functions

Platform Support

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

Legato IDE, Legato Basic