Important This documentation space contains information about PATROL Agents when deployed in a TrueSight Operations Management environment. If you are a BMC Helix Operations Management user, see PATROL Agent 22.1 for BMC Helix Operations Management.

history_get_retention()

Return the history retention value of a PATROL object.

Syntax

history_get_retention(object)

 

Parameter

Parameter

Definition

object

name of the PATROL object whose history retention value should be returned PATROL object names are expressed as strings in the following form: 
/ application/ instance/ parameter 
In this form, application , instance , and parameter are the application class, instance, and parameter names, respectively.

Description

The history_get_retention() function returns the history retention value for object. The history_get_retention()function returns the NULL string and displays a message in the computer icon console window if an error occurs.

Example

The following history_get_retention() function returns the history retention value for the parameter /USERS/USERS/USRNoUser:

print(history_get_retention("USERS/USERS/USRNoUser"),"\n");