  |
GoFiler Legato Script Reference
Legato v 1.4j Application v 5.22b
|
| Table of Contents | < < Previous | Next >> |
Chapter Five — General Functions (continued)
YesNoCancelRememberBox Function
Overview
The YesNoCancelRememberBox function displays a message box with the “Yes”, “No”, and “Cancel” buttons. A question icon is used with an option to remember the setting selected.
Syntax/Parameters
Syntax
int = YesNoCancelRememberBox ( string message, [parameters ... ] );
Parameters
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 containing a formatted error code or a standard Windows ID code: IDCANCEL, IDYES or IDNO. Use the GetLastError function to retrieve the condition of the ‘remember’ option. The id will be placed in the last error if the “Remember Choice” check box is set. Cancel is never remembered.
Remarks
Do not call the YesNoCancelRememberBox function from background threads or the command line; it returns automatically without displaying the dialog. The YesNoCancelRememberBox function supports a maximum of 4096 characters.
The YesNoCancelRememberBox 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 Formatted Strings in Section 5.2 String Functions.
Message boxes with a query cannot be opened by scripts running in the background.
This function does not support the detail and ID as set by the SetMessageBoxDetail function.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
| Table of Contents | < < Previous | Next >> |
© 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.