Adds the object to the array specified. The object is added at the end of the array. Returns 0 if successful, otherwise the error code.

Parses and adds comma separated values (i.e. a CSV string) to the named array . Returns 0 if successful, otherwise the error code.

Removes all the elements from the array

Creates a new array to be identified by the name specified. Returns 0 if successful, otherwise the error code.

Returns the object at the specified location. A null value will be returned if the index is out of range.

Inserts the object at the specified location. Returns 0 if successful, otherwise the error code.

Clears the content of the array and removes it from the memory. After removal the array with the same name needs to be recreated if needed again.

Removes the object at the specified location. Returns 0 if successful, otherwise the error code.

1. string - Name of the array
   int - Index of the object to be removed

Replaces the object at the specified location with a new one. Returns 0 if successful, otherwise the error code.

Returns the size of the array, i.e. number of elements in the array. Returns -1 if the array does not exist or if an error occurred.

Converts the content of the named array to a comma separated values (CSV) string. Returns NULL on failure.

Appends a blob to the named blob. Returns 0 if successful, otherwise the error code.

Appends a byte to the named blob. Returns 0 if successful, otherwise the error code.

Creates a new binary blob object to be identified by the name specified. Returns 0 if successful, otherwise the error code.

Returns the named blob object as a base64Binary value. Returns a null object if any error occurs.

Returns the byte value at the specified index of the named blob. Returns a null object if the index is invalid.

Deletes the named blob from the memory. Returns 0 if successful, otherwise the error code.

Deletes all the blob objects

Replaces the blob value with the binary blob value passed. Returns 0 if successful, otherwise the error code.

Sets the byte value at the specified index of the named blob. Returns 0 if successful, otherwise the error code.

Returns the size of the named blob object, i.e. the number of bytes in the byte stream owned by the blob. Returns -1 if the blob does not exist or if an error occurred.

Returns the event availability status. Use the System Calendar Availability constants to assess this value.

Returns the description of the event.

Returns the end time of the event.

Returns the event ID.

Returns the location of the event.

Returns the organiser of the event.

Returns the start time of the event.

Returns the title of the event.

Returns true if the event is an all day event, otherwise false.

Positions the cursor at the next event. Returns true if an event object is available, otherwise false.

Queries the calendar events within the specified period from all calendars configured on the device. Events are returned in chronological order.

Queries the calendar events within the specified period from the calendar specified. Events are returned in chronological order.

Removes the event fields set so far.

Sets the event value.

Creates a new event in the specified calendar using the event values populated. On success, returns the ID of the event created, null on error.

Deletes an event from the specified calendar. Returns 0 on success, otherwise the error code.

Updates an event in the specified calendar. Returns 0 on success, otherwise the error code.

Returns the display name of the calendar at the current cursor..

Returns the ID of the calendar at the current cursor..

Returns the name of the calendar at the current cursor..

Positions the cursor at the next calendar. Returns true if a calendar object is available to query, otherwise false.

Queries the available calendars on the device.

Captures an image using the built-in camera of the device. Returns 0 if the image is taken successfully, otherwise the error code.

Captures a video using the built-in camera of the device. Returns 0 if the video is taken successfully, otherwise the error code.

Returns the name of the image that has been captured, together with fully qualified file path.

If SetFileName is used, then this method will return the same name. Otherwise it will return the file name generated by the camera application.

Imports an image from the camera roll of the device. Returns 0 if the image is imported successfully, otherwise the error code.

Similar to CaptureImage(), the SetPath(), SetFile() and GetFileName() methods can be used in conjunction with this method.

Imports a video from the camera roll of the device. Returns 0 if the video is imported successfully, otherwise the error code.

Similar to CaptureImage(), the SetPath(), SetFile() and GetFileName() methods can be used in conjunction with this method.

Sets the name of the image to be captured.

If this method is not used, then GetFileName will return the file name generated by the camera application itself.

Sets the image quality.

Sets the directory in which the captured images are to be stored.

Sets the image height and width in pixels.

View the video contained in the specified file.

Note: The Camera.SetPath() method can be used in conjunction with this method.

Connects to the server network. Returns 0 if successful, otherwise the error code.

Connects to the server network using the URL (or RAS entry name) specified. Returns 0 if successful, otherwise the error code.

Disconnects BrightForms from the server network. Returns 0 if successful, otherwise the error code.

Returns the BrightForms connection type (i.e. network access, or access via Connections, or access via a RAS dialup). Use System 'Connection Manager' constants to check the returned value.

Checks if BrightForms is connected to the server network or not. Returns true if connected, otherwise false.

Checks if BrightForms needs to connect to the server network or just needs to using the existing network connection (e.g. if the user ticked 'Need To Connect Server Network' checkbox or not in Settings --> Dialup tab). Returns true if BrightForms needs to establish a connection to server network, otherwise false.

Sets the BrightForms connection type (i.e. network access, or access via Connections, or access via a RAS dialup). Use System 'Connection Manager' constants to set this value.

Adds a new column value to the temporary record

Adds a new record to the table specified using the temporary record created

Use the AddColumn method to create the temporary record.

Compacts the database. This method will compact the database only if there is no connection to the database. Returns 0 if successful, otherwise the error code. .

Deletes the records identified by the query of which name is specified

Use the SetQueryParam method if the delete query requires a parameter.

Deletes the records locally identified by the query of which name is specified. This method is provided for house keeping purposes. Database engine will NOT create sync change info for the records deleted by this method.

Use the SetQueryParam method if the delete query requires a parameter.

Executes the SQL statement. IMPORTANT NOTE : The changes made by this method does not go though the database engine. The synchronisation engine will not see the changes made. Hence the changes will not be detected and sent to the server. Use DeleteRecords or UpdateRecords instead. This method is intended for advanced users. Also note that this method does not return a resultset. It returns 0 on success, otherwise the error code.

Exports the data specified by the query to a table in the destination Access/PocketAccess database. The destination table must have the matching column names that are the output of the query. It will return 0 if the export is successful, otherwise an error code will be returned.

Returns the database engine type

Use the values prefixed with DB_ from the system Constants of the Data Source Tree to compare the result and identify what the database engine type is.

Returns the latest value of the column of the record locked by LockServerRecord method.

Returns the lock id assigned by BrightServer after calling LockServerRecord method.

Returns the name of the user who locked the record by using LockServerRecord method.

Marks a record as locked in the table specified. A particular record is identified by the column name and value pairs set by calling AddColumn method before calling this method.

This method is used with BrightServer Direct Access on a thin-client mode.

This method allows you to create a multiple user backend application with record locking.

Use with the other server locking methods especially ReleaseServerLock

Releases the lock on a record created before by LockServerRecord method

Use the LockServerRecord method first.

Resets the internal structures of the database object, and prepares it for the next operation

Always use this method before adding, updating or deleting records.

Resets the timestamp for the table specified so that the client sync engine can synchronise everything again as if nothing has been synchronised before from server. Returns 0 if successful, otherwise the error code.

Updates the system database compaction settings. Returns 0 if successful, otherwise the error code..

Stores the query parameter value in the temporary area

Use this method before applying the UpdateRecords or DeleteRecords method if the query requires a parameter.

Updates the records identified by the query of which name is specified

Use the SetQueryParam method if the update query requires a parameter.

This method returns the number of records that have been added or modified and are required to be sent to server using the query specified. The query MUST be a single query table, and it does not include the number of deleted records. Returns -1 on error.

1. string - Name of the query to be used to search the number of synchronisable changed records
   

This method returns the number of records that have been added or modified and are required to be synchronised to server. It does not include the number of deleted records. Returns -1 on error.

1. string - Name of the table to be used to search the number of synchronisable changed records.
   

This method returns the number of records that have been deleted and are required to be synchronised to server for the specified table. Returns -1 on error.

1. string - Name of the table to be used to return the number of deleted records
   

This method checks if the table specified has any added, modified or deleted records that must be sent to server. Returns true if there are any added, modified or deleted records (i.e. sync data) to be synchronised to server, otherwise false.

1. string - Table name

Starts a new database transaction. Multiple database changes can be made within a transaction. You must call "commit" method if all changes are successful, otherwise call "rollback" method to undo all the changes. Returns 0 if a transaction is started successfully.

Makes all changes made since the previous BeginTransaction method call permanent and releases any database resources currently held by this object. This method should be used only after calling BeginTransaction and all the changes made are successful. Returns 0 if the transaction has been committed successfully.

Undoes all changes made in the current transaction and releases any database resources currently held by this object. This method should be used only after calling BeginTransaction and if any of the changes made are unsuccessful. Returns 0 if the transaction has been rolled back successfully.

Imports the data stored in a CVS file into a table using the column order specified. Return 0 on success, otherwise the error code.

1. string - Name and the CSV file to be imported
   string - Table to which the CSV file content will be imported

Exports the table data specified by a query to a CVS file using the column order passed. Return 0 on success, otherwise the error code.

1. string - Name and the CSV file to which the data will be exported
   string - Query that defines the records in the table

Synchronises the table data from Dropbox. Before importing the data, the content of the local table will be deleted. Return 0 on success, otherwise the error code.

1. string - Dropbox account access token
   string - The name of the table into which the Dropbox file in CSV format is to be imported
   string - The name of the Dropbox file that the table data will be stored in CSV format.

Synchronises the changed table records to Dropbox. Upon successful upload, local changes will be deleted. Return 0 on success, otherwise the error code.

1. string - Dropbox account access token
   string - Query that defines the records in the table to be synchronised to Dropbox
   string - The name of the Dropbox file that the changed table records will be stored in CSV file format.

Creates a new datetime object of which time portion is set to midnight (00:00:00).

Creates a new datetime object

Creates a string object based on the format passed from the datetime specified

Refer to the Appendix > Date-Time Formatting and Operations chapter for Date-Time formatting.

Returns the current datetime value as a string using the format passed.

Returns the day of the month in the range 1 through 31

Returns the day of the week of the datetime value passed in the range of 1 through 7 (1=Sunday, 2=Monday,...)

Returns the day of the year of the datetime value passed

Returns the hour of the datetime value passed in the range of 0 through 23

Returns the number of milliseconds since January 1, 1970, 00:00:00.0 GMT as a string.

Returns the minute of the datetime value passed in the range of 0 through 59

Returns the month number in the range 1 through 12 (1=January)

Returns the second of the datetime value passed in the range of 0 through 59

Returns the year of the datetime value passed

Returns the current system date and time

Sets the time portion of the datetime object to midnight (00:00:00).

Sets the date portion of the datetime object

Sets the time portion of the datetime object

Returns the UTC time offset in seconds (i.e. the time difference in seconds between the local time and the UTC time). When converted to hours, this will indicate the current local time zone in relation to the UTC time zone.

Converts the local time passed to UTC (GMT) time.

Copies a file/folder in Dropbox to another file/folder in Dropbox. Returns 0 on success, otherwise the error code.

Deletes a file/folder from Dropbox. Returns 0 on success, otherwise the error code.

Downloads the specified file from Dropbox. Returns 0 on success, otherwise the error code.

Checks if the specified file or folder exists on Dropbox. Returns true if exists, otherwise false.

Returns the display name of the Dropbox account connected to.

Returns the email address of the Dropbox account connected to.

Returns the id of the Dropbox account connected to.

Returns the user name of the Dropbox account connected to.

Returns the surname of the account connected to.

Initialises the object by setting the Dropbox account access token. This method must be called first before using other methods. Returns 0 on success, otherwise the error code.

Checks if the Dropbox account being used is disabled. Returns true if disabled, otherwise false.

Moves a file/folder in Dropbox to another file/folder in Dropbox. Returns 0 on success, otherwise the error code.

Uploads the specified local file to Dropbox. Returns 0 on success, otherwise the error code.

Calls a function with no argument and no result code (e.g. "void function(void)"). It returns 0 if the function call was successful, otherwise the error code.

Calls a function with a single integer argument and no result code (e.g. "void function(int)"). It returns 0 if the function call was successful, otherwise the error code.

Calls a function with a single integer argument and an integer result code (e.g. "int function(int)"). Please use "GetFnResultCode" method to get the function result code. It returns 0 if the function call was successful, otherwise the error code.

Calls a function with a single void* argument and no result code (e.g. "void function(void*)"). It returns 0 if the function call was successful, otherwise the error code.

Calls a function with a single void* argument and an integer result code (e.g. "int function(void*)"). Please use "GetFnResultCode" method to get the function result code. It returns 0 if the function call was successful, otherwise the error code.

Calls a function with no argument and an integer result code (e.g. "int function(void)"). Please use "GetFnResultCode" method to get the function result code. It returns 0 if the function call was successful, otherwise the error code.

Returns the result code of the latest function call that returns an result code.

Loads the specified DLL module. It returns 0 if successful, otherwise the error code.

Unloads the DLL loaded. It returns 0 if successful, otherwise the error code.

Adds a new file to the email to be sent.

Call this method multiple times if the email has more than one file attachment

Adds a new recipient to bcc list

Call this method multiple times if the email has more than one Bcc email recipient

Adds a new mail recipient to cc list

Call this method multiple times if the email has more than one Cc email recipient

Adds a new recipient to direct (to) recipient list

Call this method multiple times if the email has more than one direct email recipient.

Clears (empties) the list of file attachments.

Clears (empties) the list of BCC recipients.

Clears (empties) the list of CC recipients.

Clears (empties) the list of direct TO recipients.

Resets all the settings (clears the recipient lists, store name, sender address, etc.)

Sends the email to the recipient(s) set. Returns 0 if the email is sent successfully, otherwise the error code.

Use AddTo, AddBcc, AddCc and AddAttachment first before using this method to specify the To, Cc, Bcc and attachment fields before sending the email.

Sets the email account name to be used. Note that this is not the email address, but it is the name of the account. If this method is not used, then the default email account is assumed.

Enables or disables the SSL option when sending mails. By default the SSL option is turned off.

By default the SSL option is set to false. Use this method to turn it on or off.

Sets the mail address from which the email is sent.

Sets the personal name alias for the from mail address. This will appear as the sender of the email when received.

Sets the SMTP email server address.

Sets the SMTP port number. This call is optional. If not called, then the default SMTP port number (25) will be used.

Sets the named mail object property value.

This is a reserved method to set mail object properties as recommended by the support team.

Sets the mail protocol type to be used.

By default the "smtp" protocol is used. The valid options are "smtp", "pop3" or "imap". An incorrect option will be ignored by this method.

Sets the username and password credentials for outgoing mail server authentication.

Parameters:

Copies the source file to the destination file specified. Returns true if the function is executed successfully. If the destination file already exists, then it will be overwritten.

Creates a new directory. Returns 0 if successful, otherwise the error code.

Deletes the file specified. Returns true if the file has been successfully deleted, otherwise false.

Checks if the specified file exists. Returns true if the file exists, otherwise false.

Returns the size of the specified file in bytes, or -1 on error.

Loads the binary file specified into a binary (blob) object and returns the contents of the file

Loads the text file specified into a string object and returns the contents of the file

Deletes an existing empty directory. Returns 0 if successful, otherwise the error code.

Renames (moves) the file specified. Using this function files can be moved from one location to other. Returns true if the file has been successfully renamed, otherwise false.

Saves the binary (blob) object to the file specified. Returns 0 if the function is successful.

Saves the string object to the file specified. Returns 0 if the function is successful.

Searches a directory for a file or subdirectory whose name matches the specified file name. Returns 0 if successful, otherwise an error code.

Continues a file search from a previous call to the FindFirst. Returns true if successful, otherwise false to indicate no more files or subdirectories to process.

Returns the time that the file was last written to. A null value is returned to indicate an error condition or no file is found yet.

Returns the name of the file or subdirectory found. A null value is returned to indicate an error condition or no file is found yet.

Checks if what was last found is a directory. Returns true if it is a directory, otherwise false.

Checks if what was last found is a file. Returns true if it is a file, otherwise false.

Closes the file identified by its file id.

Returns the result of the last read operation. Return value of 0 indicates success, otherwise the error code of the last read is returned.

Opens the specified file in the 'read' mode. Returns a 'file id' on success, otherwise a NULL value on failure.

Opens the specified file in the 'write' mode specified. Returns a 'file id' on success, otherwise a NULL value on failure.

Reads and returns the specified number of characters from the file. A NULL will be returned if there is nothing further to read, or an error occurred during read. Use 'GetReadResult' method to check if an error occurred during the read.

Reads and returns a line from the file. It reads the file until a file line terminator character is read. A NULL will be returned if there is nothing further to read, or an error occurred during read. Use 'GetReadResult' method to check if an error occurred during the read.

Writes the string to file. Return 0 on success, otherwise the error code.

Writes the string to file and writes the file line separator afterwards. Return 0 on success, otherwise the error code..

Closes the form.

Stops the form timer and disables it. The timer will NOT execute the action specified anymore.

Use together with EnableTimer and the Timer Interval form property to create a timer function on the form.

Enables the form timer and re-starts it. The timer will execute the action after the timer interval specified elapses.

Use together with DisableTimer and the Timer Interval form property to create a timer function on the form.

Returns the current file path

If it returns an empty file path, that means that it is in the default root directory i.e. Desktop (Win32) or My Documents (WinCE) used by the open and save file dialogs.

Returns the code of the last gesture performed by the user. Use the "Gesture" constants to check the result. Note that gestures may not be supported by all platforms.

Returns the current tab number. Note that tab numbers start from 0 (i.e. the first tab is 0, the second tab is 1 etc.)

Hides the busy mouse cursor, and displays the normal mouse pointer

Checks if the value of any control on the form has been modified by the user since the form has been loaded, or since the Form's ResetDirty or the controls' ResetDirty methods have been called.

Note:
This method will return the form's dirty state regardless whether the form is a cursor form or not.

Displays a message box. See documentation for more details.

The Message box types are derived from the system Constants Data Source Tree, use values prefixed with MB_.

Use values prefixed with ID_ from the system Constants Data Source Tree to compare the corresponding result from the message box.

Changes the form's screen brightness.

Note:
This method sets the brightness of the current form only

Sets the file path to be used by FileOpen and FileSave dialogs

Sets the form's help text displayed in the Help dialog.

Sets the form's timer interval

Displays the busy mouse pointer

Displays a file dialog where the user can select the file to be opened. It returns the file name as a string. If the selection is cancelled or no file has been selected, it returns an empty string.

Use this method to obtain a file name before using the File object methods.

Displays a file dialog where the user can select the file to be saved. It returns the file name as a string. If the selection is cancelled or no file has been selected, it returns an empty string.

Use this method to obtain a file name to save to before using the File object methods.

Displays the form's help dialog.

Displays the system's settings dialog.

Displays the system's sync progress dialog and starts the synchronisation automatically. The return value is the result of the synchronisation.

Use this method to start synchronisation after enabling all required sync rules. Refer to the Synchroniser methods to enable sync rules.

Displays the tab of which number is specified. Tab numbers start from 0 (i.e. the first tab is 0, the second tab is 1 etc.)

View the document contained in the specified file.

Note:
This method will attempt to recognise the document type and then display its content.

Returns the name of the current form aspect.

Returns the value of the child form variable specified. This method can only be used in post-close expressions.

Opens the child form specified

Use the ResetChildData method first before opening the child form.

Clears the buffers that contain the values to be passed to the child form.

This method should be used before opening the child form.

Sets the specified child form query parameter value. The value is stored into an internal buffer.

Ensure that all required child form query parameters are set before opening the child form.

Sets the specified child form variable. The value is stored into an internal buffer.

Ensure that all required child form variables are set before opening the child form.

Changes the background color of the form

Changes the form's tab text color.

Deletes the record attached to the form. Returns 0 if successful otherwise the error code.

This method will only work if there is a query binded to the form.

Enables or disables the message to be displayed when the form is about to be closed or another record is to be displayed, and the current record has not been saved yet.

Returns the current record index (i.e. the record position in the cursor form data cache). This method functions only if the form is a cursor form.

Returns the number of records the cursor form has. This method functions only if the form is a cursor form.

Checks if the cursor form is displaying the first record. This method functions only if the form is a cursor form.

Checks if the form data has been changed by the user (i.e. if the form data is dirty). Returns true if the form data (the current record) has been modified by the user, otherwise false.

Checks if the form data has been loaded successfully or not. Returns true if the form data has been loaded successfully, otherwise false.

Checks if the cursor form is displaying the last record. This method functions only if the form is a cursor form.

This method is useful as a condition if it is the last record before executing another expression i.e. validation or saving

Jumps to another record in the cursor form. The record primary key values are specified by SetJumpColumn method. Returns 0 if the specified record is found, otherwise the error code.

Use SetJumpColumn first to specify the primary key values before using the Jump method.

Navigates to the first record and displays it. This method functions only if the form is a cursor form.

Navigates to the last record and displays it. This method functions only if the form is a cursor form.

Navigates to the next record and displays it. This method functions only if the form is a cursor form.

Navigates to the previous record and displays it. This method functions only if the form is a cursor form.

Prepares the form for creating a new record. It also calls the expression specified for the form's Action-New. It is as if the user clicked on the cursor bar's 'New' button.

Re-executes the form query and re-loads the form data.

Use the Jump and SetJumpColumn methods after a form refresh to make sure that the cursor position is still on the current record displayed before the refresh.

Saves the current form data. Returns 0 if successful otherwise the error code.

This method will only work if there is a query binded to the form.

This is a useful method to call before opening a child form.

Sets the message to be displayed when the form is about to be closed or another record is to be displayed, and the current record has not been saved yet.

This should be used on a form Open event to ensure that the Confirm Save message has been set before loading any of the records.

The Confirm Save message will only be displayed if the form has a query attached to it and allows record saving.

Sets the primary key column values of the record to be jumped by using Jump method. Call this method multiple times if the form data has more than one primary key column defined.

Cursor forms by default display the current record index and the total number of records loaded on the form's title bar. Set this flag to false if you do not want to display record position on the title bar.

Enables or disables a menu item by its index. All of the menu items that can execute an expression or open another form has a unique index assigned to it. The menu item index starts from 0, and advances from top to bottom, left to right. To disable submenu items, this method should be used.

Enables or disables a menu item by its position. The position of the top most item is 0.

Calculates the distance between two GPS coordinates and returns it in "meters".

1. double - Latitude of the first GPS coordinate
   double - Longitude of the first GPS coordinate
   double - Latitude of the second GPS coordinate
   double - Longitude of the second GPS coordinate
   

Closes the COM port that the GPS device is attached. It returns 0 if successful, otherwise the error code.

Returns the current altitude in metres above mean sea level

Returns current fix quality where 0 = Invalid, 1 = GPS fix (SPS), and 2 = DGPS fix.

Returns the GPS clock as "local" datetime. It will return a "null" value if no valid reading is available.

Returns current latitude as a string, for example as "4916.46,N" where the latitude is 49 degrees 16.46 minutes NORTH

Returns current latitude in degrees. Postive values indicate NORTH.

Returns current longitude as a string, for example as "12311.12, W" where the longitude is 123 degrees 11.12 minutes WEST

Returns current longitude in degrees. Positive values indicate EAST.

Returns the number of satellites in view

Returns the current ground speed in Kilometres Per Hour

Returns the current track angle in degrees True

Returns true if there was a valid read from the GPS device, otherwise false

Opens the COM port that the GPS device is attached. It returns 0 if successful, otherwise the error code.

Opens the default native GPS port using Microsoft intermediate GPS driver, and accesses the GPS data via the native Windows GPS API. It returns 0 if successful, otherwise the error code.

Invalidates the previous read and clears the previously cached GPS data.

Sends a message to the GPS device via the COM port. It returns 0 if successful, otherwise the error code.

Closes the scanner. Returns 0 on success, otherwise the error code.

Reads the barcode from the scanner when the scan is complete. It returns an empty string if a successful scan has not occurred yet.

Returns the type of barcode label read.

This method returns the result of the most recent scan.

If the last scan was successful, this method will return 0, otherwise the error code.

Opens the scanner device for reading barcode labels. Returns 0 on success, otherwise the error code.

This method initiates a soft scan. Returns 0 on success, otherwise the error code.

This method can be called when a user clicks on a button, or an entry field is focused etc.

This method sets the name of the scanner to be used.

This method is not needed if the default scanner is used.

Closes the COM port that the magnetic stripe card is attached. It returns 0 if successful, otherwise the error code.

Returns the credit card number

Returns the expiry date given the format

Returns the month number on which the card expires

Returns the year on which the card expires

Returns the name of the card holder

Returns the data from the issuer section from Track 1

Returns the whole Track 1 data read from the magnetic stripe card

Returns the whole Track 2 data read from the magnetic stripe card

Returns true if there was a valid read from the magnetic stripe card, otherwise false

Opens the COM port that the magnetic stripe card is attached. It returns 0 if successful, otherwise the error code.

Invalidates the previous read and clears the cached card data read previously.

Removes all of the key-value pairs from the map.

string - Name of the map to be cleared

Checks if the specified key exists in the map. Returns true if the key is in the map, otherwise false.

string - Name of the map
string - Key to be checked

Creates a new map to be identified by the name specified. Returns 0 if successful, otherwise the error code.

string - Name of the map to be created

Returns the value for the key. A null value will be returned if the key does not exist in the map.

string - Name of the map
string - Key

Inserts an object at the specified key. If the key is already in the map, then its value will be replaced. Returns 0 if successful, otherwise the error code.

string - Name of the map
string - Key name
any - Object value to be inserted at the specified key

Removes the object identified by the key. Returns 0 if successful, otherwise the error code.

string - Name of the map
string - Key to be removed

Clears the content of the map and removes it from the memory. After removal, the map with the same name needs to be recreated if needed again.

string - Name of the map to be removed

Returns the size of the map, i.e. the number of key-value pairs in the map. Returns -1 if the map does not exist or if an error occurred.

string - Name of the map

Returns the absolute value of the value passed

1. any - Numeric value
   

Calculates the arccosine

1. double - Value between -1 and 1 whose arccosine is to be calculated
   

Calculates the arcsine

1. double - Value whose arcsine is to be calculated
   

Calculates the arctangent of the values passed in the range of -PI/2 to PI/2 radians. If the value passed is 0, then it returns 0.

1. double - Value whose arctangent is to be calculated
   

Calculates the arctangent of value1/value2 in the range -PI to PI radians. If both parameters are 0, the function returns 0.

1. double - Value 1
   double - Value 2
   

Returns the next highest integer that is greater than or equal to the specified numeric value

1. any - Numeric value
   

Calculate the cosine of the angle passed. The angle parameter is in radians.

1. double - Angle in radians
   

Calculate the hyperbolic cosine of the angle passed. The angle parameter is in radians.

1. double - Angle in radians
   

Returns the nearest integer that is less than or equal to the specified numeric value

1. any - Numeric value
   

Calculates logarithms of the value passed

1. double - Value whose logarithm is to be found
   

Calculates the base-10 logarithms of the value passed

1. double - Value whose base-10 logarithm is to be found
   

Returns the larger of the values passed

1. any - Value 1
   any - Value 2
   

Returns the smaller of the values passed

1. any - Value 1
   any - Value 2
   

Divides one numeric value by another numeric value and returns the remainder

1. any - Numeric value
   any - Numeric value
   

Calculates value1 raised to the power of value2

1. any - Value 1
   any - Value 2
   

Generates a pseudorandom integer number

Returns a supplied numeric value rounded to the nearest integer

1. any - Numeric value
   

Returns the sign function of a value. Returns zero if it is zero, 1 if it is greater than zero, or -1 if it is less than zero.

Calculate the sines of the angle passed. The angle parameter is in radians.

1. double - Angle in radians
   

Calculate the hyperbolic sines of the angle passed. The angle parameter is in radians.

1. double - Angle in radians
   

Calculates the square root of the value passed.

1. double - Non-negative double value
   

Calculate the tangent of the angle passed. The angle parameter is in radians.

1. double - Angle in radians
   

Calculate the hyperbolic tangent of the angle passed. The angle parameter is in radians.

1. double - Angle in radians
   

Converts an angle measured in radians to an angle measured in degrees.

1. double - Angle in radians
   

Converts an angle measured in degrees to an angle measured in radians

1. double - Angle in degrees
   

Disables the NFC object. Returns 0 on success otherwise the error code.

Enables the NFC object to access tags. Returns 0 on success otherwise the error code.

This method must be called first to access a tag for reading or writing.

Returns the type of the NFC event which has just been triggered.

Use System NFC Event Type constants to check the event type returned. This method should normally be used in the expression that is run by the form's NFC action event.

Returns the result of the last operation carried out, such as a write operation.

This method should normally be used in the expression that is run by the form's NFC action event.

Reads the NDEF formatted tag, and returns the tag data as a string value. Returns NULL on error.

The tag data will be read from the first record of the first message stored in the tag.

Writes a string to the NDEF formatted NFC tag as a Text type. Returns 0 on success, otherwise the error code.

Parameters:

The new tag data will be stored in the first record of the first message.

Writes a string to the NDEF formatted NFC tag as a URI type. Returns 0 on success, otherwise the error code.

Parameters:

The new tag data will be stored in the first record of the first message.

Returns the result of a bitwise AND operation performed on two numeric values

Returns the result of a bitwise inclusive OR operation performed on two numeric values

Returns the result of a bitwise exclusive OR operation performed on two numeric values

Returns the next highest integer that is greater than or equal to the specified numeric value

Returns the nearest integer that is less than or equal to the specified numeric value

Returns the high byte of the integer passed

Returns the low byte of the integer passed

Checks if the object is a double. If a string is passed, it will be checked to see if it is a valid double string.

This method is useful when validating double input values.

Checks if the object is an integer. If a string is passed, it will be checked to see if it is a valid integer string.

This method is useful when validating integer input values.

Creates an integer by combining the high and low byte values passed

Divides one numeric value by another numeric value and returns the remainder

Generates a pseudorandom integer number

Returns a supplied numeric value rounded to the nearest integer

Shifts the bits in the integer value to left

Shifts the bits in the integer value to right

Converts the value passed to boolean (true/false). If the value is 0, then it is converted to false, otherwise to true

Converts the value passed to double

Converts the value passed to integer

Use this method to convert values to integer after a mathematical operation such as addition.

Creates a 16 byte Globally Unique Identifier (GUID) number and returns it as a string containing 36 characters in total in the following format including dashes : "00112233-4455-6677-8899-AABBCCDDEEFF". Returns null if the method fails.

Use this method to create unique GUIDs. This method is available only Windows platform.

Returns the number of milliseconds since the midnight

Returns an unique integer based on the system time

Use this method to create unique ids for the database records.

Returns the value of the column specified.

Use the SetQuery or SetSql methods to establish a query or sql statement before using this method.

Navigates to the next record.

Call this method as you scroll from record to record to learn whether you have more records in the recordset to process. Returns true if there are more records to process; otherwise if you are after the last record, it returns false.

Use this method as a WHILE loop condition to iterate through the resultset.

Sets the name of the query to be executed. On success it returns 0, otherwise the error code.

Sets the query parameter value in the query selected. Make sure the query name is set before using this method. On success it returns 0, otherwise the error code.

Sets the SQL statement to be executed.

Compares the first value to the second value using the comparison operator. If the result evaluates to true, then it returns the first result value, otherwise the second result value is returned.

Returns the current page number of the report being printed

Prints the specified report. On success it returns 0, otherwise the error code.

Sets the number of copies of the document to be printed. Important to note that it is always set back to 1 (one) after each report print request is executed.

Sets the report query parameter value. On success it returns 0, otherwise the error code.

Sets the report variable.

Sets the flag that determines if the printer dialog is skipped or not. When set to true, the report engine will not display the printer selection dialog and the report will be printed to the default printer. By default the printer dialog is displayed.

Closes the scanner. Returns 0 on success, otherwise the error code.

This method sets the flag to turn on or off the beep generated after a successful scan.

Reads the barcode from the scanner when the scan is complete. It returns an empty string if a successful scan has not occurred yet.

Returns the type of barcode label read.

This method returns the result of the most recent scan.

If the last scan was successful, this method will return 0, otherwise the error code.

Opens the scanner device for reading barcode labels. Returns 0 on success, otherwise the error code.

By default it uses the default scanner. Use SetScannerName method to set the desired scanner name, if necessary.

This method initiates a soft scan. Returns 0 on success, otherwise the error code.

This method can be called when a user clicks on a button, or an entry field is focused etc.

This method sets the name of the scanner to be used.

This method is not needed if the default scanner is used.

Decrypts the binary blob using the password passed and returns the decrypted string. If the function fails, it returns a null object.

Encrypts the string using the password passed and returns the encrypted data in a binary blob. If the function fails, it returns a null object.

Calculates the MD5 digest for the value (string or binary) passed and returns the digest as a string

Sets the encryption / decryption algorithm to be used. The default algorithm used is 3DES.

Closes the specified COM port. It returns 0 if successful, otherwise the error code.

Flushes input and output buffers of the specified COM port. It returns 0 if successful, otherwise the error code.

Returns the last error code for the specified COM port. It will return 0 if there was no error for the last action carried out on the COM port in question. It will return the error code 11262, if a timeout has occurred.

Opens the specified COM port. It returns 0 if successful, otherwise the error code.

Reads binary data from the specified COM port and returns the data read as a base64binary (blob) object. If there was nothing to read, then an empty blob object is returned. If there was an error or the function timed out, then a null object is returned. Use GetLastError to get the error code for the port in question.

Reads a binary message from the specified COM port. The message starts with the start byte value specified and ends with the byte value specified. If there was nothing to read, then an empty blob is returned. If there was an error or the function has timed out, then a null object is returned. Use GetLastError to get the error code for the port in question.

Reads data from the specified COM port and returns the data read as a string. If there was nothing to read, then an empty string is returned. If there was an error or the function timed out, then a null object is returned. Use GetLastError to get the error code for the port in question.

Reads a string message from the specified COM port. The message starts with the start character specified and ends with the end character specified. If there was nothing to read, then an empty string is returned. If there was an error or the function has timed out, then a null object is returned. Use GetLastError to get the error code for the port in question.

Sends the binary byte stream (blob) to the specified COM port. It returns 0 if the binary data has been sent successfully, otherwise the error code.

Sends a string to the specified COM port. It returns 0 if the string has been sent successfully, otherwise the error code.

Adds a new entry the recipient list

Call this method multiple times if the SMS message has more than one recipient.

Resets all the settings (clears the recipient list etc.)

Sends a text message to the recipient(s) set. Returns 0 if the text message is sent successfully, otherwise the error code.

Returns the first character to the string passed as an integer value.

Compares the two strings specified. Zero if the strings are identical, a negative number if first string is less than the second string, a postive number if the first string is greater than the second string.

Compares the two strings specified ignoring case. Zero if the strings are identical, a negative number if first string is less than the second string, a postive number if the first string is greater than the second string.

Converts number to string using the format details.

Extracts the character at the specified index and returns as a string

Returns the index within the string of the first occurrence of the specified string. If no such string occurs in this string, then -1 is returned.

Inserts a string into the source string at the specified location and returns a new string. On any error, the original string will be returned.

Creates a single character string by converting the integer value to a character.

Checks if the character is an alphabetic character

Checks if the character is a decimal-digit character

Returns true if the string is empty, otherwise false

Checks if the character is a lower character

Checks if the character represents a printable character

Checks if the character is an uppercase character

Checks if the character represents a whitespace character

Extracts the first (leftmost) number of characters specified from input string and returns a copy of the extracted substring

Returns the length of the input string (i.e. the number of characters in the string).

Extracts the number of characters specified starting from the location passed from the input string, and returns a string containing those extracted characters

Creates a new string by repeating the specified string for the number of times specified.

Replaces all occurrences of one string with another in the input string, and returns a new string.

Returns the index of the character from the end of the string specified. If no such character occurs in this string, then -1 is returned.

Extracts the last (rightmost) number of characters specified from input string and returns a copy of the extracted substring

Sets (changes) the character at the specified index

Converts the string to lowercase, and returns a new string

Converts the input string to uppercase, and returns a new string

Removes the leading and trailing whitespace characters from the input string, and returns a new string

Removes the leading whitespace characters from the input string, and returns a new string

Removes the trailing whitespace characters from the input string, and returns a new string

Closes the scanner. Returns 0 on success, otherwise the error code.

Reads the barcode from the scanner when the scan is complete. It returns an empty string if a successful scan has not occurred yet.

Returns the type of barcode label read.

This method returns the result of the most recent scan.

If the last scan was successful, this method will return 0, otherwise the error code.

Opens the scanner device for reading barcode labels. Returns 0 on success, otherwise the error code.

By default a scanner named 'SCN1:' is opened. This is the name of the default scanner. Use SetScannerName method to set the desired scanner name, if necessary.

This method initiates a soft scan. Returns 0 on success, otherwise the error code.

This method can be called when a user clicks on a button, or an entry field is focused etc.

This method sets the name of the scanner to be used.

This method is not needed if the default scanner is used.

Establishes a server connection. It return a negative -10519 if new application updates have been received from server. Returns 0 if successful otherwise a positive error code.

This method goes hand in hand with Disconnect and ExecuteSyncRule methods to create your own synchronisation dialog instead of using the built-in Form.ShowSyncDialog.

Disables all the sync rules. Returns 0 if successful otherwise the error code.

A good design practice is to disable all sync rules before synchronisation to ensure that unnecessary synchronisation are not executed. Use this method before enabling the required sync rules.

Closes the server connection. Returns 0 if successful otherwise the error code.

This method goes hand in hand with Connect and ExecuteSyncRule methods to create your own synchronisation dialog instead of using the built-in Form.ShowSyncDialog.

Enable the sync rule specified. Returns 0 if successful otherwise the error code.

Use the Form.ShowSyncDialog to start synchronisation after enabling the sync rules.

Executes the sync rule specified. Returns 0 if successful otherwise the error code.

This method goes hand in hand with Connect and Disconnect methods to create your own synchronisation dialog instead of using the built-in Form.ShowSyncDialog.

This method allows you to prioritise or sequence the sync rules that you want to run.

Sets the execution order of a sync rule. Note that sync rules are executed in the ascending execution order.

Disables all of the background sync rules

Returns the last background synchronisation error

Returns the time of the last successful background synchronisation

Returns the name or the comma separated names of the tables that were synchronised successfully by the last background synchronisation.

Returns the name or the comma separated names of the sync rules that were executed by the last background synchronisation.

Returns the number of pending background sync requests initiated by SynchroniseInBackground method

Returns true if a background synchronisation is already in progress, otherwise false

This method marks a sync rule as a background executable sync rule. Returns 0 if successful otherwise the error code.

Clears the number of pending background sync requests counter

Sets the idle time of the background synchroniser. The background synchroniser sleeps for the duration specified to give change other components of BrightForms to execute. During this period, the background synchroniser does not process any sync requests. The minimum idle time that can be set is 5 seconds. It is by default 5 seconds.

Sets the retry time of the background synchroniser to retry a failed sync rule. The minimum retry time that can be set is 300 seconds (5 minutes). It is by default 10 minutes.

Starts background synchronisation by singnalling the background synchroniser to execute enabled background sync rules

Returns the version of the BrightForms engine in which the application is running. If the BrightForms version is 1.2.3, then it will return 10203. That is, the major version is multiplied by 10000, and the minor version is multiplied by 100 and then they are simply added to the third bug fix version number. Similarly for Version 5.2.0, it will return 50200; and for Version 6.0.5, it will return 60005; and so on.

Returns the unique device id as a string

Returns the name of the device

Returns the amount of space available on a disk volume in Kilo Bytes (KB). It returns -1 if the method is unsuccessful.

Use an empty string or "\" for the main storage on the device.

Use "\Memory Card" or "\Storage Card" to find out the available free space on a SD card.

Use "c:\" for the free disk space on the C: drive on a desktop application.

Returns the comma separated list of IP addresses. An empty string will be returned on error

Returns the OS specific line separator.

Returns the today's BrightForms settings password based on the current system date

Starts an external program. It does not wait for the external program to complete. The string passed must contain the path, the name of the program and the arguments to be passed to the program. Returns true if the program is started successfully, otherwise returns false.

The command line to be passed to the executable module MUST be enclosed in double qoutes ("").

Starts an external program and waits for the external program to finish. The string passed must contain the path, the name of the program and the arguments to be passed to the program. Returns zero if the external program has completed successfully, otherwise returns the error code returned from the external program.

The command line to be passed to the executable module MUST be enclosed in double qoutes ("").

Sets the name of the RAS dialup entry to be used by BrightForms to initiate a call to BrightServer. Returns 0 if successful, otherwise the error code.

Suspends the execution of the application for a specified interval.

Returns the current battery level in percentage. Returns -1 if the battery level cannot be queried.

Returns the battery status. Use System constants to check the returned value. Returns -1 if the battery status cannot be queried.

Returns true if the battery is on AC power and charging, otherwise false.

Returns the comma separated list of the names of the languages defined in the application. This is the list of short ISO language names (e.g. "def,en_US,fr"). Note that the application's default language is returned as "def" in the list.

Returns the application's current language name. This is the short ISO name (e.g. "en" for English or "en_AU" for Australian English or "def" for the default language). Note that the application's default language is returned as "def".

Sets the application language. BrightForms will use the resource strings for this language to present the application interface. To use the default application language, then specify "def" as the language name. Returns 0 if successful, otherwise the error code.

1. string - Short ISO language name. This must be one of the languages defined in the application. Otherwise an error is returned. Use "def" to set the default language as the application language.

Display a notification message to the user outside of the application's normal UI.  When the user taps on the notification, the app will be brought to the foreground, in the same way as tapping the launch icon does..

Supported on Android only.

When you tell the system to issue a notification, it first appears as an icon in the notification area. To see the details of the notification, the user opens the notification drawer. Both the notification area and the notification drawer are system-controlled areas that the user can view at any time.

Terminates the application and returns the status code passed to the operating system.

IMPORTANT NOTE: This method will terminate the application immediately without any cleanups or proper shutdown steps. Therefore it must be used with extreme caution as it may lead to data losses if not used correctly.

Returns the operating system type that BrightForms is currently running on. Use system constants to evaluate the returned OS id.

Returns the major version of the operating system that BrightForms is currently running on

Returns the minor version of the operating system that BrightForms is currently running on

Returns the name of the project author

Returns the project description

Returns the id of the project

Returns the project release number assigned by BrightServer

Returns the user assigned project version set in BrightBuilder project settings

Executes the specified object action.

Clears the object state that has been configured so far.

Sets the value of the named object property/attribute.

Sets the value of the named object property/attribute as a 64 bit long value. Simply the value passed will be converted to a long number and set as the property/attribute value.

Enables/disables the specified form aspect..

Note:
Disabled form aspects will not be included in the aspect calculations, and will not be shown on the device.

Returns the name of the default aspect.

Returns the height of the screen in pixels.

Returns the width of the screen in pixels.

Sets the name of the default aspect.

Returns the database name including full file path

Returns the user password from the settings file

Returns the full directory path where the project files are stored

Returns the port number configured for the push listener