ssc_disableKPInst()

The function disables KPI instances.

Synopsis

void ssc_disableKPInst(const dyn_string kpiInsts);

Parameters

Parameter Description
kpiInsts Instances that should be disabled.

Return Value

0 (void)

Description

The function disables KPI instances. This means that the connection to the data points is not built and the check boxes in the KPI associate panel are deactivated. Disabled KPI instances are not updated at runtime.

Example

The function disables the KPI instances "kpi_System1__ssc_demo_drive1_myNewKPI" and "kpi_System1__ssc_demo_drive2_myNewKPI".

main()
{
  const dyn_string kpiInsts;
  dyn_string kpiInsts =
  makeDynString("kpi_System1__ssc_demo_drive1_myNewKPI",
  "kpi_System1__ssc_demo_drive2_myNewKPI");
  ssc_disableKPInst(kpiInsts);
}
Figure 1. The function disableKPInst() disables the KPI instances and the check boxes are deactivated

Assignment

KPI functions

Availability

SmartSCADA