SetProperty method

Allows properties to be set on a class instance that modify various aspects of its behavior.

Syntax
Boolean SetProperty(String name, String Value)
Remarks

Changes to property values only affect synchronization requests made after the property value was changed.

The server path property can be set to specify the directory from which the client should start dbmlsync.exe when the StartServer method is called. When this property is not set, dbmlsync.exe is found using the path environment variable. See StartServer method.

The following properties control the types of events that are returned by the GetEvent method. By disabling events that you do not require you may be able to improve performance. An event type is enabled by setting the corresponding property to "1" and disabled by setting the property to "0". The following is a list of the available properties and the event type that each controls:

Property name Event type(s) controlled Default
enable errors DBSC_EVENTTYPE_ERROR_MSG 1
enable warnings DBSC_EVENTTYPE_WARNING_MSG 1
enable info msgs DBSC_EVENTTYPE_INFO_MSG 1
enable progress DBSC_EVENTTYPE_PROGRESS_INDEX 0
enable progress text DBSC_EVENTTYPE_PROGRESS_TEXT 0
enable title DBSC_EVENTTYPE_TITLE 0
enable sync start DBSC_EVENTTYPE_SYNC_START 1
enable sync done DBSC_EVENTTYPE_SYNC_DONE 1
Parameters
  • name   The name of the property to set. This must be one of the property names defined above.

  • value   The value to set the property to.

Returns

Returns true if the property was successfully set.

Returns false if the property was not successfully set. When false is returned, you can call the GetErrorInfo method to get more information about the failure. See GetErrorInfo method.