Loading...
 
Print

Sync Module for Windows Code Documentation

Table of contents

Properties

PesslSync.Sync.ErrorMessage
Summary: Don't use this property. It is obsolete

PesslSync.Sync.isSilent
Summary: should the messages be displayed.

PesslSync.Sync.ParentForm
Summary: descendant of windows.form if this property is set to an existing form this form will be activated when progress window is closed

PesslSync.Sync.isError
Summary: indicates if there were any error

PesslSync.Sync.raiseException
Summary: If isError is equal to true, this object holds last exception object

PesslSync.Sync.sException
Summary: defines, weather the module passes exception to the user application or suppresses it

PesslSync.Sync.AutoSync
Summary: defines if synchronization should be called automatically when data is read

Methods

PesslSync.Sync.Login(System.String,System.String)
Summary: stores user name and password used for all other functions
Param: userName : user name
Param: userPwd : user password

PesslSync.Sync.DoSync()
Summary: synchronizes all data of all stations
Returns: True if synchronization was successfull, False otherwise.

PesslSync.Sync.DoSyncStationList()
Summary: synchronizes station list of the user
Returns: True if synchronization was successfull, False otherwise.

PesslSync.Sync.DoReSyncOneStation(System.String)
Summary: resynchronizes all data of station stationName
Param: stationName : The the name of station to resynchronize.
Returns: True if synchronization was successfull, False otherwise.

PesslSync.Sync.DoSyncOneStation(System.String)
Summary: synchronizes all data of station stationName
Param: stationName : The the name of station to synchronize.
Returns: True if synchronization was successfull, False otherwise.

PesslSync.Sync.SetParams(MobileSyncNet2.PesslSync.DbParams@)
Summary: returns all params saved in the database
Param: db_params :

PesslSync.Sync.SetParam(System.String,System.String)
Summary: stores parameter with name name and value value
Param: name : name of parameter
Param: value : value of parameter

PesslSync.Sync.GetParam(System.String)
Summary: reads parameter name from database
Param: name : name of parameter
Returns: value of parameter. Nothing if parameter does not exists

PesslSync.Sync.ReadDbPath()
Summary: returns the full path to the database
Returns: full path to the database

PesslSync.Sync.SetDbPath(System.String)
Summary: stores the full path to the database
Param: path : full path to the database

PesslSync.Sync.GetVersion()
Summary: returns the version of the module
Returns: version of the module

PesslSync.Sync.GetStationList(System.Data.DataSet@)
Summary: reads station list of user
Param: ds : dataset to return data

PesslSync.Sync.GetStationSensors(System.String,System.Data.DataSet@)
Summary: reads sensors of staion station_name
Param: station_name : name of station
Param: ds : dataset to return data

PesslSync.Sync.GetMinMaxDate(System.String,System.DateTime@,System.DateTime@,System.Int32)
Summary: returns dates of first and last data records of station station_name
Param: station_name : The the name of station.
Param: first_date : output parameter that holds the fist date
Param: last_date : output parameter that holds the last date
Returns: True if there is at least 1 data record, False otherwise.

PesslSync.Sync.GetStationDataFirst(System.String,System.Data.DataSet@,System.Int32,System.Int32)
Summary: reads first row_count or less records of data for station
Param: station_name : name of station to read data for
Param: ds : dataset
Param: group_code : code of grouping 0-raw data, 1-hourly, 2-daily
Param: row_count : number of records to read
Returns: number of records actually read

PesslSync.Sync.GetStationDataLast(System.String,System.Data.DataSet@,System.Int32,System.Int32)
Summary: reads last row_count or less records of data for station
Param: station_name : name of station to read data for
Param: ds : dataset
Param: group_code : code of grouping 0-raw data, 1-hourly, 2-daily
Param: row_count : number of records to read
Returns: number of records actually read

PesslSync.Sync.GetStationDataPrev(System.String,System.Data.DataSet@,System.Int32,System.Int32)
Summary: reads prevous (related to prvious call) row_count or less records of data for station
Param: station_name : name of station to read data for
Param: ds : dataset
Param: group_code : code of grouping 0-raw data, 1-hourly, 2-daily
Param: row_count : number of records to read
Returns: number of records actually read

PesslSync.Sync.GetStationDataFromDate(System.String,System.DateTime,System.Data.DataSet@,System.Int32,System.Int32)
Summary: reads row_count or less records of data for station starting from dt
Param: ds : dataset
Param: station_name : name of station to read data for
Param: dt : time to start readingfrom
Param: group_code : code of grouping 0-raw data, 1-hourly, 2-daily
Param: row_count : number of records to read
Returns: number of records actually read

PesslSync.Sync.GetStationDataNext(System.String,System.Data.DataSet@,System.Int32,System.Int32)
Summary: reads next (related to prvious call) row_count or less records of data for station
Param: station_name : name of station to read data for
Param: ds : dataset
Param: group_code : code of grouping 0-raw data, 1-hourly, 2-daily
Param: row_count : number of records to read
Returns: number of records actually read

PesslSync.Sync.DBdeleteStation(System.String)
Summary: deletes all data of the station station_name
Param: station_name : Name of station to delete

PesslSync.Sync.DBEmpty()
Summary: deletes all data from all tables of the database

PesslSync.Sync.DBCompact()
Summary: Compacts the database. Should be called regularly

PesslSync.Sync.DBgetConnection()
Summary: returns the dbConnection object connected to the underlying database. Connection is open and ready to use. Note that connection object can refer to different database types. User application should only use standard SQL. User application should always close connection using DBcloseConnection().
Returns:

PesslSync.Sync.DBcloseConnection()
Summary: Closes connection opened by the function DBgetConnection()


Created by Vitaly. Last Modification: Friday 13 of November, 2009 16:01:06 GMT by Vitaly.