GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

OkCancelBox Function

Overview

The OkCancelBox function displays a message box with the “OK” and “Cancel” buttons or queries via the default console.

Syntax/Parameters

Syntax

int = OkCancelBox ( [int type], string message, [parameters ... ] );

Parameters

type

An optional int containing an icon type. This parameter can also contain a char value that resolves to an integer. The permissible values are:

	'I'	MB_INFO	Information
	'N'	MB_NONE	None (no icon)
	'Q'	MB_QUESTION	Question
	'S'	MB_STOP	Stop
	'X'	MB_EXCLAMATION	Exclamation

 

type is not case-sensitive. See Message Box introduction for more information.

message

A string to display. If additional parameters are present, message is considered a formatted string. See Section 5.2 String Functions for more information on formatted strings.

parameters

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

Return Value

Returns an int value as a formatted error code or a standard Windows ID code: IDCANCEL (2) or IDOK (1).

Remarks

Do not call the OkCancelBox function from background threads or the command line; it returns automatically without displaying the dialog. The OkCancelBox function supports a maximum of 4096 characters.

The OkCancelBox 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 format of the string and the data to be inserted depend upon the structure of the message parameter and the contents of the additional parameters passed to the function. For more information on formatted strings, see Section 5.2 String Functions for more information on formatted strings.

Message boxes with a query cannot be opened by scripts running in the background.

In console mode, the console will be presented with an option line. Form example:

rc = OkCancelBox("This is a test, ok?"); 

Presents:

This is a test, ok? OK[Enter], Cancel[Escape]:

Related Functions

AddMessage — Adds a formatted message to the default or a specified log, or other object.

IsCancel — Checks the value to see if it is a cancel error code (ERROR_CANCEL) or 2 (IDCANCEL).

LogCreate — Creates a general log object with an optional log name and target filename base.

MessageBox — Displays an ‘OK’ style message box.

SetMessageBoxDetail — Sets detailed message data and optional ID for the next message box display.

UseMessageBoxes — Overrides console only messages to use message boxes.

YesNoBox — Displays a ‘Yes/No’ style message box.

YesNoCancelBox — Displays a ‘Yes/No/Cancel’ style message box.

Platform Support

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

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 10/21/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.