LUALoriotPro WEB site

LoriotPro scripting documentation
Extensions for LUA language

Table of contents Search function

Print the current page Mail this  link UTUBE Channel version française

lpav.FindRef - Find a graphical object from one of its attached reference

LoriotPro has extended the LUA sripting language by providing its own LUA libraries. The new functions provided are dedicated to the creation of monitoring and SNMP automation application.

Syntax 

objet_number = lpav.FindRef(number (1-4), mode, string,array);

Description

Allow to select a group of graphical Active View objects with their reference variables. All the objects that contain the specified string in the specified reference variable number are selected. A reference variable is the name of the group of object a user defined reference that are assigned with the lpav.SetRef function.

A graphical object has 4 reference variables. These reference variables are used to create groupe of graphical objects or for object manipulation. The first object in the list become the default object of the group. If the arry variable is specified then all the graphical objets selected are listed in this array variable.

Parameters

Number - The reference number either 1, 2, 3 or 4

Mode - The case mode, 1 nocase sensitive, 0 case sensitive

string - The character string that your are looking for. The name of the group of object a user defined reference.

array -The array name that store the results

Return Values

Case : uid =lpav.FindRef(number (1-4), mode, “string”);

uid - UID of the default graphical object or nil if error.

Case : objet_number=lpav.FindRef(number (1-4), mode, “string”,”array”);

object_number - The number of object in the array or nil if errorl.

Array description

arrayname[0] The first graphical object in the array
arrayname[1]

The second graphical object in the array

 
arrayname[x] The x graphical object in the array

Exemple

See lpav.SetRef




www.loriotpro.com