iscEngineOpen()

Purpose

iscEngineOpen() opens a handle to the synchronization engine.

Syntax

isy_INT32 iscEngineOpen(
    HISCCONF     hConf,
    HISCENG     *phEngine);

Function arguments

Table 135 lists the valid arguments used with the iscEngineOpen() function.

Table 135. iscEngineOpen() arguments

Data type	Argument	Use	Description
HISCCONF	`hConf`	input	Config handle
HISCENG*	`phEngine`	output	Handle to the synchronization engine

Usage

Use iscEngineOpen() to open a handle to the sync engine (HISCENG) when synchronizing the specified configuration. The handle returns through *phEngine upon successful completion of the synchronization. If the synchronization does not complete successfully, the *phEngine value is NULL, and an error code returns.

Return codes

ISCRTN_Succeeded : OK
ISCRTN_OutOfMemory : Out of memory
ISCRTN_ResourceBusy : Resource locked (for example, by another application)
ISCRTN_NotPermitted : Resource not accessible (for example, resource is not readable)
ISCRTN_NotFound : Resource not found (for example, the path is not found)
ISCRTN_Failed : Otherwise

Restrictions

Avoid multiple calls to iscEngineOpen() since multiple calls open multiple handles to the synchronization engine and might cause consistency problems.

Related concepts

The sample Sync Client C/C++ application

Related tasks

Developing DB2 Everyplace Sync Client applications using C/C++

Related reference