iscEngineSetPref()

Purpose

iscEngineSetPref() sets the preferences of the synchronization engine.

Syntax 

isy_INT32 iscEngineSetPref(
    HISCENG              hEngine,
    isy_CONST isy_INT32  prefID,
    isy_CONST isy_TCHAR *prefVal);

Function arguments

ǥ 147 lists the valid arguments used with the iscEngineSetPref() function.

ǥ 147. iscEngineSetPref() arguments

Data type Argument Use Description
HISCENG hEngine input Handle to the synchronization engine
isy_CONST isy_INT32 prefID input Preference ID, which is one of the following values:
  • ISCPREF_Timeout: Timeout length for receiving messages
  • ISCPREF_Trace: Detailed trace.
isy_CONST isy_TCHAR* prefVal input New preference value to set. There are some pre-defined preference constants.

For the ISCPREF_Trace preference:

  • ISCCONST_TraceON: Turn on detailed debugging trace
  • ISCCONST_TraceOFF: Turn off detailed debugging trace

For the ISCPREF_Timeout preference:

  • ISCCONST_TimeoutNever: Never timeout while waiting for the server reply .
  • ISCCONST_TimeoutMinimum: Minimum timeout length

Usage

Use iscEngineSetPref() to set the preferences of the synchronization engine. These preferences are not persistent, and they must be reset each time a new handle to the synchronization engine opens.

Return codes

Restrictions

The provided preference values should be within the specified preference limits:

Related concepts

Related tasks

Related reference