Home
Client APIs and toolsYou can use the HCL OneDB™ implementation of client APIs to develop applications for HCL OneDB™ database servers.
Change Data Capture API Programmer's GuideThese topics describe how to program applications to process changed data from HCL OneDB™ databases using the HCL® OneDB® Change Data Capture API.The HCL OneDB™ Change Data Capture API Programmer's Guide describes how to program applications to process changed data from HCL OneDB™ databases using the HCL® OneDB® Change Data Capture API.
Change Data Capture functionsThese topics describe the Change Data Capture functions.
The cdc_deactivatesess() functionStops capturing data for an active capture session.

The cdc_deactivatesess() function

Stops capturing data for an active capture session.

The syscdcsess table is updated to show that the capture session is not active.

Syntax

Function argument

Table 1. The cdc_deactivatesess() argument
Argument	Data Type	Description
`session_ID`	INTEGER	The session ID of the capture session that you want to deactivate.

Usage

Use the cdc_deactivatesess() function to stop capturing data for a specific capture session. However, you do not need to run the cdc_deactivatesess() function if you run the cdc_closesess() and the cdc_deactivesess() functions.

You must call this function from a client application. You cannot call this function from a user-defined routine that runs within the database server.

Return values

If successful, returns 0.

If unsuccessful, returns an integer corresponding to an error code and updates the syscdcsess table with the error information.