Functions
There are two ways to view the CNS Audit function reference, the Function Reference below, and the Function Reference Browser in a new window.
Function ReferenceThe Function Reference is a complete reference for CNS Audit functions. Click on a function title to view more information which includes the function description, parameter information, example usage and more. | Function Reference Browser![]() The Function Reference Browser offers better navigation for the CNS Audit functions, you can Launch Function Browser in a new window. |
Function Reference
- CNSAudit_AccessLog
This function allows you to log any custom action to the CNS Action Log table. This is most useful in scripts where you want to log something that the user did, such as logging in or running a... read more
- CNSAudit_Configure
Calling this function with no parameters will open the CNS Audit Configuration Dialog. You can optionally open to a specific tab by specifying the name of the tab as the "Option" parameter. This... read more
- CNSAudit_Init
This function creates an initial set of Audit Trail data from an existing database. After setting up your database with the CNS Audit Timestamp and CNS Audit Trigger fields, this function can be used... read more
- CNSAudit_ListSiblingIDs
When CNS Audit audits a record, it does its best to determine which Table Occurrence the record was audited through and uses that Table Occurrence Name and ID to log the audit to the CNS Audit Log... read more
- CNSAudit_RecordChange
This is the main logging function. This records all changes made to the fields in the database. The CNSAudit_RecordChange function is used within an Auto-Enter Text field named "CNS Audit Trigger".... read more
- CNSAudit_RecordDelete
This function is used in a Limited Delete Record Privilege to track record deletions. See the CNS Audit Setup Guide for instructions on how to use... read more
- CNSAudit_RecordOpen
This function is used in a Limited Edit Record Privilege for two purposes: the first is to audit the record before the user edits it if it has never been audited before, and the second is to log to... read more
- CNSAudit_RecordView
This function is used in a Limited View Record Privilege to track record views to the CNS Access Log. See the CNS Audit Setup Guide for instructions on how to use... read more
- CNSAudit_Register
You can use this function to Register the plug-in from a script instead of through the Configuration Dialog. This is useful when the plug-in is being distributed to many computers, allowing you to... read more
- CNSAudit_RollBack
Use this function to undo any changes, including record deletions, that have been logged to the CNS Audit Log table. It's best to use this function when logged in as a [Full Access] user or within a... read more
- CNSAudit_SetupFile
This function brings up a dialog for setting up the Auditing Preferences for the database file. The dialog has settings for what fields to edit as well as a place to define custom log... read more
- CNSAudit_ShutdownFile
CNS Audit uses a cache system to speed up the process of auditing records as a user changes them. This cache is normally cleared out during the few seconds here and there when the user is not... read more
- CNSAudit_StartupFile
This function can be used in a Startup Script to let CNS Audit load information about this database that it needs to perform the auditing operations. While this is optional for single-file databases... read more
- CNSAudit_SuspendFile
Use this function to temporarly suspend, and later resume, auditing operations. You can suspend auditing to the CNS Audit Log table, the CNS Access Log table, or both. Note: This function only... read more
- CNSAudit_Version
This function returns the current version of CNS Audit. This function is useful for testing whether or not the plug-in is installed and enabled. If you call this function and a question mark ("?")... read more
- CNSAudit_VersionAutoUpdate
This function returns an Auto Update friendly Version number of CNS Audit. The format of this version number is always exactly 8 digits long. The first two digits represent the major version of the... read more
