Difference between revisions of "NXSL:SetCustomAttribute"

From NetXMS Wiki
Jump to navigation Jump to search
Line 1: Line 1:
__NOTOC__
__NOTOC__
Set value of node's custom attribute. If attribute was not defined, it will be created.
Set value of objects custom attribute. If attribute was not defined, it will be created.


'''Since:''' 1.1.1
'''Since:''' 1.1.1


== Syntax ==
== Syntax ==
SetCustomAttribute(''node'', ''attributeName'', ''value'')
SetCustomAttribute(''object'', ''attributeName'', ''value'')


== Parameters ==
== Parameters ==
{| class="wikitable"
{| class="wikitable"
|-
|-
| ''node'' || [[NXSL:Node|Node]] object, 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 [[SG:Security Issues|Security Issues]] for more information).
| ''object'' || Any object of [[NXSL_Class_Reference|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 [[SG:Security Issues|Security Issues]] for more information).
|-
|-
| ''attributeName'' || Custom attribute name.
| ''attributeName'' || Custom attribute name.

Revision as of 18:20, 21 December 2017

Set value of objects custom attribute. If attribute was not defined, it will be created.

Since: 1.1.1

Syntax

SetCustomAttribute(object, attributeName, value)

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.
value New value for custom attribute.

Return Value

Previous value of requested custom attribute or NULL if attribute was not defined before.

Examples

SetCustomAttribute($node, "my_attribute", "new value")			-> "old value"
SetCustomAttribute($node, "non_existing_attribute", "new value")	-> NULL