  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Nine — Dialog Functions (continued)
Overview
The CheckboxGetState function retrieves the check state of a radio button or checkbox.
Syntax/Parameters
Syntax
int = CheckboxGetState ( int id );
Parameters
id
An int containing the control ID of a radio button or checkbox.
Return Value
Returns an int representing the checked state of the control. On error, BST_UNCHECKED (0) is returned. To check for a control or other error, use the IsError or GetLastError functions to retrieve a formatted error code. The following return codes are possible:
| Return code | Code | Description | ||||
| BST_CHECKED | 0x00000001 | Button is checked | ||||
| BST_INDETERMINATE | 0x00000002 | Button is grayed, indicating an indeterminate state (applies only if the button has the BS_3STATE or BS_AUTO3STATE style). | ||||
| BST_UNCHECKED | 0x00000000 | Button is cleared |
The function will return ERROR_RANGE if id is an invalid control ID for the open dialog or ERROR_INVALID_HANDLE if no dialog is open.
Remarks
This function largely relates to radio and checkbox controls. Note that only one radio button of a radio button group can be checked at a given time.
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.