AlmSummaryDisable

The AlmSummaryDisable function disables the alarm at the current cursor position in an active data browse session.

This function is a non-blocking function. It does not block the calling Cicode task.

Syntax

INT AlmSummaryDisable(INT iSession [, INT EndTime [, STRING Comment]] )

iSession:

The handle to a browse session previously returned by an AlmSummaryOpen call.

EndTime:

A date/time variable that indicates when the alarm will no longer be disabled. If this parameter is omitted or set to 0, the alarm will be disabled indefinitely.

Comment:

An optional comment limited to 200 characters explaining why the alarm is disabled. If the comment exceeds 200 characters, hardware error 274 ("Invalid argument passed") will be displayed.

Return Value

0 (zero) if the alarm browse session exists, otherwise an error code is returned.

Related Functions

AlmSummaryAck, AlmSummaryClear, AlmSummaryClose, AlmSummaryDelete, AlmSummaryDeleteAll, AlmSummaryEnable, AlmSummaryFirst, AlmSummaryGetField,AlmSummaryLast, AlmSummaryNext, AlmSummaryOpen, AlmSummaryPrev, AlmSummaryNumRecords

Examples

// Retrieve the handle to a browse session returned by an AlmSummaryOpen call.
// ...
// Disable the associated alarm for the next 60 minutes
nEndTime = DateAdd(TimeCurrent(), 3600);
AlmSummaryDisable(iSession, nEndTime, "Shelve alarm for 60 minutes.");

// Retrieve the handle to a browse session returned by an AlmSummaryOpen call.
// ...
// Disable the associated alarm until 20 Dec 2016 6:30am local time
nEndTime = DateAdd(StrToDate("20/12/2016"), StrToTime("6:30"));
AlmSummaryDisable(iSession, nEndTime, "Shelve alarms until 20 Dec 2016 6:30am");