AutoPatrol, Bureaucrats, Administrators
481
edits
Difference between revisions of "NXSL:GetDCIObject"
m
Text replacement - "^" to "{{deprecated}}"
(Created page with "__NOTOC__ Return DCI object or null. == Syntax == GetDCIObject(''node'', ''DCI id''); == Parameters == :{| |- | ''node'' || Node object, you can use predefi...") |
m (Text replacement - "^" to "{{deprecated}}") |
||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | {{deprecated}}__NOTOC__ | ||
Get DCI object with given ID. | |||
== Syntax == | == Syntax == | ||
GetDCIObject(''node'', '' | GetDCIObject(''node'', ''id''); | ||
| Line 13: | Line 13: | ||
| ''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). | | ''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). | ||
|- | |- | ||
| '' | | ''id'' || DCI id on node. | ||
|} | |} | ||
| Line 19: | Line 19: | ||
== Return Value == | == Return Value == | ||
[[NXSL:DCI|DCI]] object with given id on success or '''null''' on failure (if id does not exist, or access to it was denied). | [[NXSL:DCI|DCI]] object with given id on success or '''null''' on failure (if object with given id does not exist, or access to it was denied). | ||
== Examples == | == Examples == | ||
GetDCIObject($node, 2) -> object | GetDCIObject($node, 2) -> object | ||
GetDCIObject($node, bad_id) -> NULL | |||