You are here: start » abeu:start » abeu:commands
Commands Available to ABEU
The following is a list of public and private procedures within Access BE Updater.
Public Procedures
These procedures can be called from anywhere in your code. To call them, you must have a clsBEUpdater object open. For example, the following code will backup all of your databases:
Private Sub cmdButton1_Click()
Dim clsBEUpdater as New clsBEUpdater
clsBEUpdater.BackupDBs ' <-- This will backup your databases
set clsBEUpdater = Nothing
End Sub
BackupDBs()
This procedure backs up all Databases specified in the Updater_Databases table to a folder with today's date and time.
This procedure is called automatically during RunAccessBEUpdater().
RunAccessBEUpdater()
This is the main sub-routine that should be executed as the first line in your application. This will verify that the back-end data file is up to date. If it is not up to date, it will ask the user if they want to update, initiate an automated backup, and update the data file.
AllDBsValid()
Public Function AllDBsValid() As Boolean
fDoesFieldExist()
Public Function fDoesFieldExist(dbsMyDB As Database, strTableName As String, strFieldName As String) As Boolean
fDoesTableExist()
Public Function fDoesTableExist(strTableName As String, strFieldName As String) As Boolean
fGetDatabasesListForComboBox()
Public Function fGetDatabasesListForComboBox(blnIncludeOptionForCurrentDB As Boolean, [strCurrentDBName As String = ” (Current DB)”]) As String
fGetDataFileVersionsList()
Public Function fGetDataFileVersionsList() As Integer()
fGetDataFileVersionsListForComboBox()
Public Function fGetDataFileVersionsListForComboBox() As String
fGetINIPath()
Private Function fGetINIPath() As String
GetDataFileVersions()
Public Function GetDataFileVersions([intDatabaseID As Integer])
Private Procedures
These are procedures that are only available to the class itself and cannot be called from any other module.
LoadDefaults()
This loads the contents of the BEUpdater.ini file into Updater_Databases. This is called automatically when the class is initialized.
LoadRecordsets()
Parameters:
- Optional myCursorType As CursorTypeEnum = adOpenForwardOnly
- Optional myLockTypeEnum As LockTypeEnum = adLockOptimistic
This loads the 4 tables (Updater_Databases, Updater_Fields, Updater_Master, and Updater_Properties) used by ABEU into the variables mrsDatabases, mrsFields, mrsMaster, and mrsProperties. These can then be manipulated as necessary.
You can specify another CursorTypeEnum or LockTypeEnum if you wish.
UnloadRecordsets()
This should be called after loading the recordsets.