UM:NetXMS Scripting Language (NXSL) - Revision history

AlexKirhenshtein: Text replacement - "^" to "{{deprecated}}"

2022-09-13T16:13:55Z

Text replacement - "^" to "{{deprecated}}"

← Older revision		Revision as of 16:13, 13 September 2022
Line 1:		Line 1:
	{{DISPLAYTITLE:NetXMS Scripting Language (NXSL)}}		{{deprecated}}{{DISPLAYTITLE:NetXMS Scripting Language (NXSL)}}

Phil at 14:16, 5 October 2020

2020-10-05T14:16:59Z

← Older revision		Revision as of 14:16, 5 October 2020
Line 4:		Line 4:
	{\| style="border-spacing: 20px; border: 20px solid red;"		{\| style="border-spacing: 20px; border: 20px solid red;"
	\|		\|
	'''WARNING''': This page is no longer updated. Please visit '''[https://www.netxms.org/documentation/nxsl-latest/ ~~NetXMS Scripting~~ Language]''' for current version of the documentation.		'''WARNING''': This page is no longer updated. Please visit '''[https://www.netxms.org/documentation/nxsl-latest/#_language_syntax Language syntax]''' for current version of the documentation.
	\|}		\|}

Phil at 13:51, 5 October 2020

2020-10-05T13:51:05Z

@@ Line 1: / Line 1: @@
 {{DISPLAYTITLE:NetXMS Scripting Language (NXSL)}}
 = NXSL Overview =
 In many parts of the system, fine tuning can be done by using NetXMS built-in scripting language called NXSL (stands for NetXMS Scripting Language). NXSL was designed specifically to be used as embedded scripting language within NetXMS, and because of this has some specific features and limitations. Most notable is very limited access to data outside script boundaries – for example, from NXSL script you cannot access files on server, nor call external programs, nor even access data of the node object other than script is running for without explicit permission. NXSL is interpreted language – scripts first compiled into internal representation (similar to byte code in Java), which than executed inside NXSL VM.

Tomas Kirnak: Clarified array creation and usage

2015-12-16T22:00:26Z

Clarified array creation and usage

← Older revision		Revision as of 22:00, 16 December 2015
Line 223:		Line 223:
	== Array Initialization ==		== Array Initialization ==

	New array can be created in two ways. First is to use '''array''' operator:		New array can be created in two ways. First is to use '''array''' operator. <br>
			This statement will create empty array and assign reference to it to variable ''a''.
			<syntaxhighlight lang="c">
			array a;
			</syntaxhighlight>


			You can then assign values to the array like this.<br>
			Please note arrays in NXSL are sparse, so you can have elements with nothing in between.
	<syntaxhighlight lang="c">		<syntaxhighlight lang="c">
	array a;		array a;

			a[1] = 1;
			a[2] = 2;
			a[260] = 260;

			println(a[1]); // will print 1
	</syntaxhighlight>		</syntaxhighlight>

	~~This statement will create empty array and assign reference to it to variable ''a''.~~

	~~Second way is to use %( ) construct to create array already populated with values:~~

			Second way is to use %( ) construct to create array already populated with values.<br>
			This statement will create array with four elements at positions 0, 1, 2, and 3, and assign reference to this array to variable ''a''.
	<syntaxhighlight lang="c">		<syntaxhighlight lang="c">
			// no need to use "array a;" here, since we are creating it dirrectly
	a = %(1, 2, 3, 4);		a = %(1, 2, 3, 4);

			println(a[0]); // will actually print 1, since 1 is the 0th member
	</syntaxhighlight>		</syntaxhighlight>

	~~This statement will create array with four elements at positions 0, 1, 2, and 3, and assign reference to this array to variable ''a''.~~ Array initialization can also be used directly in expressions, like this:
			Array initialization can also be used directly in expressions, like this:

	<syntaxhighlight lang="c">		<syntaxhighlight lang="c">

Victor at 18:17, 27 October 2015

2015-10-27T18:17:44Z

@@ Line 361: / Line 361: @@
 | style="border-top:none;border-bottom:0.0007in solid #000000;border-left:0.0007in solid #000000;border-right:none;padding-top:0.0236in;padding-bottom:0.0236in;padding-left:0.075in;padding-right:0.075in;"| Match
 | style="border-top:none;border-bottom:0.0007in solid #000000;border-left:0.0007in solid #000000;border-right:0.0007in solid #000000;padding-top:0.0236in;padding-bottom:0.0236in;padding-left:0.075in;padding-right:0.075in;"| <tt>TRUE</tt> if ''a'' is matched to regular expression ''b''. As a side effect, assigns values to special variables $1, $2, $3, etc. See ''Regular Expressions'' for details.
 |}

Victor at 17:23, 27 October 2015

2015-10-27T17:23:28Z

← Older revision		Revision as of 17:23, 27 October 2015
Line 32:		Line 32:
	Everything inside /* */ is considered a comment and will be ignored by interpreter. You can enclose comments, like below:		Everything inside /* */ is considered a comment and will be ignored by interpreter. You can enclose comments, like below:

	<syntaxhighlight>		<syntaxhighlight lang="c">
	/* comment /* another comment / still comment /		/* comment /* another comment / still comment /
	</syntaxhighlight>		</syntaxhighlight>

Tomas Kirnak at 14:08, 25 November 2014

2014-11-25T14:08:35Z

← Older revision		Revision as of 14:08, 25 November 2014
Line 76:		Line 76:

	return is another built-in operator which exits the function and sets it's return value.		return is another built-in operator which exits the function and sets it's return value.


			= Script entry point =
			NXSL handles script entry in 2 ways:<br>
			* Explicit main() function
			* Implicit $main() fucntion

			If an explicitelly defined main() exists, it will be called.

			If an explicit main() doesnt exist, an implicit $main() fucntion will be created by the script interpreter and the script will enter at the $main() function.<br>
			The $main() fucntion is constructed from code that is not a part of any other functions.

Victor: /* Arrays */

2013-02-17T11:29:43Z

Arrays

← Older revision		Revision as of 11:29, 17 February 2013
Line 204:		Line 204:
	A ''key'' must be a non-negative integer. When an array is created, its size is not specified and its map can have empty spots in it. For example, an array can have a element with a ''0'' key and an element with ''4'' key and no keys in-between. Attempting to access an array key which has not been defined is the same as accessing any other undefined variable: the result will be <tt>NULL</tt>.		A ''key'' must be a non-negative integer. When an array is created, its size is not specified and its map can have empty spots in it. For example, an array can have a element with a ''0'' key and an element with ''4'' key and no keys in-between. Attempting to access an array key which has not been defined is the same as accessing any other undefined variable: the result will be <tt>NULL</tt>.

			Array elements can be accessed using [''index''] operator. For example, to access element with index 3 of array ''a'' you should use

			<syntaxhighlight lang="c">
			a[3];
			</syntaxhighlight>

			== Array Initialization ==

			New array can be created in two ways. First is to use '''array''' operator:

			<syntaxhighlight lang="c">
			array a;
			</syntaxhighlight>

			This statement will create empty array and assign reference to it to variable ''a''.

			Second way is to use %( ) construct to create array already populated with values:

			<syntaxhighlight lang="c">
			a = %(1, 2, 3, 4);
			</syntaxhighlight>

			This statement will create array with four elements at positions 0, 1, 2, and 3, and assign reference to this array to variable ''a''. Array initialization can also be used directly in expressions, like this:

			<syntaxhighlight lang="c">
			sub f()
			{
			return %(2, "text", %(1, 2, 3));
			}
			</syntaxhighlight>

			In this example function ''f'' returns array of 3 elements - number, text, and another array of 3 numeric elements.

	= Operators =		= Operators =

Lukas Rypl: Added category

2013-01-28T06:52:11Z

Added category

← Older revision		Revision as of 06:52, 28 January 2013
Line 498:		Line 498:

	Without short-circuit evaluation, trim(x) would cause run-time error if x is null. Also, long running function will only be called if condition (trim(x) == "abc") will be false.		Without short-circuit evaluation, trim(x) would cause run-time error if x is null. Also, long running function will only be called if condition (trim(x) == "abc") will be false.


			[[Category:Scripting Guide]]

Victor at 10:17, 27 December 2012

2012-12-27T10:17:54Z

@@ Line 460: / Line 460: @@
+   }
 </syntaxhighlight>
 == return ==
@@ Line 485: / Line 486: @@
 The last example of expressions is combined operator-assignment expressions. You already know that if you want to increment ''a'' by 1, you can simply write '''a''++' or '++''a'''. But what if you want to add more than one to it, for instance 3? In NXSL, adding 3 to the current value of ''a'' can be written '''a'' += 3'. This means exactly "take the value of ''a'', add 3 to it, and assign it back into ''a''". In addition to being shorter and clearer, this also results in faster execution. The value of '''a'' += 3', like the value of a regular assignment, is the assigned value. Notice that it is NOT 3, but the combined value of ''a'' plus 3 (this is the value that's assigned into ''a''). Any two-place operator can be used in this operator-assignment mode.