  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Nine — Dialog Functions (continued)
DataControlSetActionReturnCode Function
Overview
The DataControlSetActionReturnCode function sets an action return code.
Syntax/Parameters
Syntax
int = DataControlSetActionReturnCode ( int id, dword code );
Parameters
id
An int containing the control ID of the data control.
code
A dword specifying the return code.
Return Value
Returns an int as ERROR_NONE or a formatted error code on failure. Common error codes are as follows: 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
Do to structural processing restrictions, the action procedure cannot return a value to the initiating procedure. The DataControlSetActionReturnCode allows for a code to be set. This is useful for cancelling on sheet cell edit operations or other actions that require a return value.
The default return code for an action is ERROR_NONE.
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.