Difference between revisions of "NXSL:FindObject"

From NetXMS Wiki
Jump to navigation Jump to search
(Clarified returned object type behaviour)
Line 22: Line 22:
== Return Value ==
== Return Value ==


Node object with given id or name on success or '''null''' on failure (either because object with given name/id does not exist, or access to it was denied).
Object of NetObj or one of its sub-clases (depending on found object type) with given id or name on success or '''null''' on failure (either because object with given name/id does not exist, or access to it was denied).<br>
For more info see [[NXSL Class Reference|NXSL Class Reference]].





Revision as of 15:33, 26 January 2016

Find NetXMS object by object id or name.

Since: 1.2.0


Syntax

FindObject(id, node);


Parameters

id ID or name of the object to find.
node Node object, you can use predefined variable $node to refer to current node. You can also use null or omit this parameter if trusted nodes check is disabled (see Security Issues for more information).


Return Value

Object of NetObj or one of its sub-clases (depending on found object type) with given id or name on success or null on failure (either because object with given name/id does not exist, or access to it was denied).
For more info see NXSL Class Reference.


Examples

FindObject("server.netxms.org", $node)	-> object
FindObject(2)				-> object
FindObject("bad_object_name", $node)	-> NULL