NXSL:GetCustomAttribute

From NetXMS Wiki
Revision as of 18:19, 21 December 2017 by Tomas Kirnak (talk | contribs)
Jump to navigation Jump to search

Get value of objects custom attribute.

Syntax

GetCustomAttribute(object, attributeName)

Parameters

object Any object of NetObj class, or its sub-classes.

You can use predefined variable $node to refer to current node. You can also use null as node if trusted nodes check is disabled (see Security Issues for more information).

attributeName Custom attribute name.

Return Value

String value of requested custom attribute or NULL if attribute is missing.

Notes

If attribute name conforms to NXSL identifier naming conventions, it can be accessed directly as node object attribute. For example “GetCustomAttribute($node, "my_attribute")” can be changed to “$node->my_attribute”. If custom attribute does not exist, accessing via "->" will generate error. Alternative way it to use syntax "my_attribute@$node", which will return NULL for missing attribute instead.

Examples

GetCustomAttribute($node, "my_attribute")	-> "my value"
GetCustomAttribute($node, "bad_attribute_name")	-> NULL