Using SyncBackPro > Technical Reference > Scripting

These are functions that can be accessed from scripts via the SBProfiles object. For example:

SBProfiles.IsValidProfileName('Example Name')

The SBProfiles object is accessible from all scripts and was introduced in SyncBackPro V11.

All the example code below is written in using the Pascal scripting language.

function CopyingFromDestination(ProfileName);

ProfileName: The name of the profile

Return value: TRUE if the profile is configured to copy from the destination

This function returns TRUE if the profile is copying from the destination, e.g. it is a backup from FTP.

function DisableProfile(ProfileName,Reason);

ProfileName: The profile to disable

Reason: The reason the profile has been disabled

Return value: TRUE if the profile name is disabled

This function disables a profile.

NOTE: This function was introduced in V12.

function EnableProfile(ProfileName,Reason);

ProfileName: The profile to enable

Return value: TRUE if the profile name is enabled

This function enabled a profile.

NOTE: This function was introduced in V12.

function GetProfileType(ProfileName, var Description);

ProfileName: The name of the profile

Description: Description is set to a description of the profile type

Return value: The type of the profile (EExactProfileTypes)

This function returns the type, and description, of a profile using the profiles name. To get a list of profiles use SBSystem.ProfileCount and SBSystem.GetProfileName

function GetUserDefinedFolder(var Restricted);

Restricted: Restricted is set to TRUE if only the user defined folder should be used

Return value: The user defined folder, or empty string if one is not being used

This function returns the user-defined folder to store profiles, if there is one. If the settings state that only the user defined folder should be used then Restricted is returned as TRUE.

function IsValidProfileName(ProfileName);

ProfileName: The name to test

Return value: TRUE if the profile name is valid

This function returns TRUE if a profile name is valid (legal) and can be used.