event_range_manage()

Change the status of PATROL events in a specified event ID range.

Syntax

event_range_manage(maxcount,newstatus,username,IDrange)

Parameters

Parameter

Definition

maxcount

string that is the maximum number of events that will be affected by the status change Specifying the NULL string " " causes maxcount to default to 100.

newstatus

string that is the new status to be assigned to each event*Valid Values* 
ACKNOWLEDGED 
CLOSED 
DELETED

username

string that is the user name of the person changing the event status The username is placed in each event diary.

IDrange

string that is the range of PATROL event IDs eligible for this event_range_manage() function*Valid Values* 
x event ID x 
x/y event IDs between and including x and y 
/y event IDs less than and including y 
x/ event IDs greater than and including x 
/ all events 
x and y are integers such with the following ranges: 
0 ≤ x ≤ y ≤ 2,147,483,647

Description

The event_range_manage() function assigns newstatus to maxcount PATROL events whose event IDs are within IDrangeand writes username in the event diary for each of the modified events.

Note

Choose the value of maxcount with care. Large maxcount values cause more work for the PATROL Agent and can impact its performance.

Managing events using the event_range_manage() function follow the same rules used for managing events from the PATROL Console or the PATROL Event Manager (PEM) Console. For example, you cannot acknowledge an event that is closed.

Example

The following event_range_manage() function acknowledges a maximum of 15 events whose event IDs are 30 and above. The user ID used to acknowledge the events is Fred.

event_range_manage("15","ACKNOWLEDGED","Fred","30/-");
Was this page helpful? Yes No Submitting... Thank you

Comments