AutoPatrol, Bureaucrats, Administrators
481
edits
Difference between revisions of "NXSL:GetCustomAttribute"
NXSL:GetCustomAttribute (view source)
Revision as of 16:13, 13 September 2022
, 16:13, 13 September 2022Text replacement - "^" to "{{deprecated}}"
(Created page with "__NOTOC__ Get value of node's custom attribute. Function returns requested attribute's value on success or NULL if given attribute does not exist. == Syntax == GetCustomAttri...") |
m (Text replacement - "^" to "{{deprecated}}") |
||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | {{deprecated}}__NOTOC__ | ||
Get value of | Get value of objects custom attribute. | ||
== Syntax == | == Syntax == | ||
GetCustomAttribute( | GetCustomAttribute(''object'', ''attributeName'') | ||
== Parameters == | == Parameters == | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
| | | ''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. | ||
|} | |} | ||
== Return Value == | == Return Value == | ||
String value of custom attribute or '''NULL''' if attribute is missing. | String value of requested custom attribute or '''NULL''' if attribute is missing. | ||
== Notes == | == 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 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 == | == Examples == | ||
GetCustomAttribute($node, "my_attribute") | GetCustomAttribute($node, "my_attribute") -> "my value" | ||
GetCustomAttribute($node, "bad_attribute_name") -> NULL | |||
GetCustomAttribute($node, "bad_attribute_name") -> NULL | |||