iscEngineGetPref()

Purpose

iscEngineGetPref() retrieves the current preference setting.

Syntax 

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

Function arguments

Table 148 lists the valid arguments used with the iscEngineGetPref() function.

Table 148. iscEngineGetPref() 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_TCHAR* prefVal output Pointer to the buffer for storing the returned preference value. 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
isy_CONST isy_INT32 prefLen input The size of the provided buffer (prefVal)

Usage

Use iscEngineGetPref() to get the preference setting (which is either a default value or the value set by iscEngineSetPref()) of a synchronization engine.

Return codes

Restrictions

The provided buffer should be large enough to store the values of the various preferences:

Related concepts

Related tasks

Related reference