Members

How it's used

Applicable Version

Property ARMAuthenticationType As ARMAuthenticationType

Retrieve/specify audit database authentication type – SQL server authentication or Windows authentication.

HRESULT ARMAuthenticationType([out, retval] ARMAuthenticationType* pVal);

HRESULT ARMAuthenticationType([in] ARMAuthenticationType newVal);

Example (VBScript):

Retrieving:

If WindowsAuthentication = oBackup.ARMAuthenticationType Then

'…

End If

Specifying:

oBackup.ARMAuthenticationType = SQLServerAuthentication

EFT Server v6.3 and later

Property ARMDatabaseName As String

Retrieve/specify ARM database name.

HRESULT ARMDatabaseName([out, retval] BSTR *pVal);

HRESULT ARMDatabaseName([in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "ARM database name is: " & oBackup.ARMDatabaseName

Specifying:

oBackup.ARMDatabaseName = "EFTDB"

EFT Server v6.3 and later

Property ARMDatabaseType As ARMDatabaseType

Retrieving/specifying audit database type.

HRESULT ARMDatabaseType([out, retval] ARMDatabaseType* pVal);

HRESULT ARMDatabaseType([in] ARMDatabaseType newVal);

Example (VBScript):

Retrieving:

If Oracle  = oBackup.ARMDatabaseType Then

'…

End If

Specifying:

oBackup.ARMDatabaseType = SQLServer

EFT Server v6.3 and later

Property ARMFailureAuditFolder As String

Retrieve/specify folder to save auditing data when the database has an error.

HRESULT ARMFailureAuditFolder([out, retval] BSTR* pVal);

HRESULT ARMFailureAuditFolder([in] BSTR newVal)

Example (VBScript):

Retrieving:

Auditfolder = oBackup.ARMFailureAuditFolder

Specifying:

oBackup.ARMFailureAuditFolder = "C:\some_folder"

EFT Server v6.3 and later

Property ARMFailureEmailList As String

Retrieve/specify a failure notification list of emails. The property is a string with the following format:

email :== recipient_name<addr@server.domain> | addr@server.domain

email_list :== email; email_list | e

HRESULT ARMFailureEmailList([out, retval] BSTR* pVal);

HRESULT ARMFailureEmailList([in] BSTR newVal);

Example (VBScript):

strEmailList = oBackup.ARMFailureEmailList

If strEmailList <> "" Then

strEmailList = strEmailList + "; "

End If

strEmailList = strEmailList + "NewRecipientName<SomeAddr@SomeMailServer.com>"

oBackup.ARMFailureEmailList = strEmailList

EFT Server v6.3 and later

Property ARMPassword As String

Retrieve/specify ARM database password.

HRESULT ARMPassword([out, retval] BSTR *pVal);

HRESULT ARMPassword([in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "ARM database passoword is: " & oBackup.ARMPassword

Specifying:

oBackup.ARMPassword = "swordfish"

EFT Server v6.3 and later

Property ARMServerName As String

Retrieve/specify database host address.

HRESULT ARMServerName([out, retval] BSTR *pVal);

HRESULT ARMServerName([in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "ARM database host address is: " & oBackup.ARMServerName

Specifying:

oBackup.ARMServerName = "192.168.0.55"

EFT Server v6.3 and later

Property ARMStopAuditingOnError As Boolean

Retrieve/specify server behavior in case of database error. If ARMStopAuditingOnError is true, then after database error, audit will stop. Otherwise, auditing will be continued in the folder specified by the ARMFailureAuditFolder property.

HRESULT ARMStopAuditingOnError([out, retval] VARIANT_BOOL* pVal);

HRESULT ARMStopAuditingOnError([in] VARIANT_BOOL newVal);

Example (VBScript):

Retrieving:

If oBackup.ARMStopAuditingOnError Then

'…

End If

Specifying:

oBackup.ARMStopAuditingOnError = true

EFT Server v6.3 and later

Property ARMUserName As String

Retrieve/specify database user name.

HRESULT ARMUserName([out, retval] BSTR *pVal);

HRESULT ARMUserName([in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "ARM database username is: " & oBackup.ARMUserName

Specifying:

oBackup.ARMUserName = "User_1"

EFT Server v6.3 and later

Property BackupArchivePath As String read-only

Retrieve path to the backup archive file.

HRESULT BackupArchivePath([out, retval] BSTR* pVal);

Example (VBScript):

MsgBox "File backup archive path: " & oBackup.BackupArchivePath

EFT Server v6.3 and later

Property CreatedBy As String read-only

Retrieve administrator account name that created the backup.

HRESULT CreatedBy([out, retval] BSTR* pVal);

Example (VBScript):

MsgBox "Backup created by: " & oBackup.CreatedBy

EFT Server v6.3 and later

Property CreationTime As Date read-only

Retrieve backup creation time.

HRESULT CreationTime([out, retval] DATE* pVal);

Example (VBScript):

MsgBox "Backup created: " & oBackup.CreationTime

EFT Server v6.3 and later

Property EnableARM As Boolean

Retrieve/specify enable/disable ARM.

HRESULT EnableARM([out, retval] VARIANT_BOOL *pVal);

HRESULT EnableARM([in] VARIANT_BOOL newVal);

Example (VBScript):

Retrieving:

MsgBox "ARM is enabled: " & CStr(oBackup.EnableARM)

Specifying:

oBackup.EnableARM = True

EFT Server v6.3 and later

Function GetSiteBackupInfo(nIndex As Long) As Object

Retrieve ICISiteBackupInfo interface by index.

HRESULT GetSiteBackupInfo([in] LONG nIndex, [out, retval] IDispatch** pVal);

Example (VBScript):

Set oSiteBackupInfo = oBackup.GetSiteBackupInfo(0)

EFT Server v6.3 and later

Sub SetSiteBackupInfo(newVal As Object)

Specify Site backup information.

HRESULT SetSiteBackupInfo([in] IDispatch* newVal);

Example (VBScript):

oBackup.SetSiteBackupInfo oSiteBackupInfo

EFT Server v6.3 and later

Property SitesCount As Long read-only

Retrieve number of Sites in the backup archive.

HRESULT SitesCount([out, retval] LONG* pVal);

Example (VBScript):

MsgBox "Sites count: " & CStr(oBackup.SitesCount)

EFT Server v6.3 and later

Property type As String read-only

Retrieve string representation of backup type.

HRESULT Type([out, retval] BSTR* pVal);

Example (VBScript):

MsgBox "Backup type: " & oBackup.Type

EFT Server v6.3 and later