smc_drop_alarm

Description

Removes an alarm on a data item in a view.

Syntax

SMC_RETURN_CODE smc_drop_alarm
 (SMC_CONNECT_ID   clientId,
 	SMC_VIEW_ID      viewId,
 	SMC_ALARM_ID     alarmId)

Parameters

clientId: identifies the connection.

viewId: identifies a view created on the connection.

alarmId: identifies the alarm.

Returns

Return value	Indicates
SMC_RET_SUCCESS	Function succeeded.
SMC_RET_FAILURE	Function failed.
SMC_RET_BUSY	Function not executed, connection is busy.
SMC_RET_INVALID_CONNECT	Connection does not exist.

Examples

Example 1

The following example assumes that:

You have created a connection and have a clientId.
You have created a view on that connection and have a viewId.

You have created an alarm on that view and have an alarmId.

if (smc_drop_alarm(clientId,
                  viewId,
                  alarmId) != SMC_RET_SUCCESS) 
 {
 		printf("smc_drop_alarm_failed\n");
 		exit(1);
 }

Usage

You cannot drop an alarm created while defining a Historical session (that is, when the connection mode is SMC_SERVER_M_HISTORICAL).

Valid server modes

Mode	Availability
SMC_SERVER_M_LIVE	Yes
SMC_SERVER_M_HISTORICAL	No

Errors

Error	Indicates
SMC_RET_INVALID_VIEWID	Function failed.
SMC_RET_INVALID_ALARMID	Alarm does not exist.