Administrative API Reference

db2QuerySatelliteProgress

Checks on the status of a satellite synchronization session.

Authorization

None

Required Connection

None

Version

db2ApiDf.h

C API Syntax 



/* File: db2ApiDf.h */
/* API: db2QuerySatelliteProgress */
/* ... */
SQL_API_RC SQL_API_FN
  db2QuerySatelliteProgress (
    db2Uint32 versionNumber,
    void * pParmStruct,
    struct sqlca * pSqlca);
 
typedef struct
{
  db2int32 oStep;
  db2int32 oSubstep;
  db2int32 oNumSubsteps;
  db2int32 oScriptStep;
  db2int32 oNumScriptSteps;
  char * poDescription;
  char * poError;
  char * poProgressLog;
} db2QuerySatelliteProgressStruct;
/* ... */

API Parameters

versionNumber
Input. Specifies the version and release level of the structure passed in as the second parameter, pParmStruct.

pParmStruct
Input. A pointer to the db2QuerySatelliteProgressStruct structure.

pSqlca
Output. A pointer to the sqlca structure. For more information about this structure, see SQLCA.

oStep
Output. The current step of the synchronization session (defined in db2ApiDf.h).

oSubstep
Output. If the synchronization step (oStep) can be broken down into substeps, this will be the current substep.

oNumSubsteps
Output. If there exists a substep (oSubstep) for the current step of the synchronization session, this will be the total number of substeps that comprise the synchronization step.

oScriptStep
Output. If the current substep is the execution of a script, this parameter reports on the progress of the script execution, if available.

oNumScriptSteps
Output. If a script step is reported, this parameter contains the total number of steps that comprise the script's execution.

poDescription
Output. A description of the state of the satellite's synchronization session.

poError
Output. If the synchronization session is in error, a description of the error is passed by this parameter.

poProgressLog
Output. The entire log of the satellite's synchronization session is returned by this parameter.

[ Top of Page | Previous Page | Next Page ]