The AlmBrowseDisable function disables the alarm tag 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 AlmBrowseDisable(INT iSession [, INT EndTime [, STRING Comment]] )
iSession:
The handle to a browse session previously returned by an AlmBrowseOpen call.
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
AlmBrowseAck, AlmBrowseEnable, AlmBrowseClose, AlmBrowseFirst, AlmBrowseGetField, AlmBrowseNext, AlmBrowseNumRecords, AlmBrowseOpen, AlmBrowsePrev
Examples
// Retrieve the handle to a browse session returned by an AlmBrowseOpen call. // ... // Disable the associated alarm for the next 60 minutes nEndTime = DateAdd(TimeCurrent(), 3600); AlmBrowseDisable(iSession, nEndTime, "Shelve alarm for 60 minutes.");
// Retrieve the handle to a browse session returned by an AlmBrowseOpen call.
// ...
// Disable the associated alarm until 20 Dec 2016 6:30am local time
nEndTime = DateAdd(StrToDate("20/12/2016"), StrToTime("6:30"));
AlmBrowseDisable(iSession, nEndTime, "Shelve alarms until 20 Dec 2016 6:30am");
See Also
Published June 2018