Description
Sets the checked status of the checkbox form field at the given field ID.
Applies to
Syntax
rtename.FormCheckBoxSetChecked(integer fieldID, boolean checked)
|
Argument |
Description |
|---|---|
|
fieldID |
The unique ID assigned to the checkbox form field. |
| checked | The status that you want to set the checkbox field to. |
Return value
Integer.
Returns 1 if it succeeds. Returns -1 if an error occurs. Returns -2 if the fieldID is non-existent, illegal, or not of the required type. If any argument's value is null, returns null.
Examples
This example inserts a checkbox form field, and then calls the FormCheckBoxSetChecked function to set its status:
integer li_formid,li_rtn li_formid = rte_1.FormCheckBoxInsert(true,"Y","N") li_rtn = rte_1.FormCheckBoxSetChecked(li_formid,false)
