iscConfigGetSubsSetStatus()

Purpose

iscConfigGetSubsSetStatus() gets the synchronization status of a subscription set.

Syntax

isy_INT32 iscConfigGetSubsSetStatus(
    HISCCONF    hConf,
    isy_TCHAR*  id);

Function arguments

Table 134 lists the valid arguments used with the iscConfigGetSubsSetStatus() function.

Data type	Argument	Use	Description
HISCCONF	`hConf`	input	Config connection
isy_TCHAR*	`id`	input	Subscription-set ID

Usage

Use iscConfigGetSubsSetStatus() to query the sync status of a subscription set (with the provided ID) during its last synchronization.

Return codes

ISCRTN_Succeeded : The synchronization of the subscription set succeeded.
ISCRTN_Ready : The subscription set is enabled. The synchronization process started but has not yet synced the subscription set.
ISCRTN_Canceled : The synchronization of the subscription set is canceled.
ISCRTN_Failed : The synchronization of the subscription set failed.
ISCRTN_NotFound : The subscription set is not found.

Restrictions

None.

Related concepts

Related tasks

Related reference