improved debug in network map update code
[public/netxms.git] / doc / nxsl.npp.calltips.xml
1 <?xml version="1.0" encoding="Windows-1252" ?>
2 <NotepadPlus>
3 <AutoComplete language="NXSL">
4 <Environment ignoreCase="no" startFunc="(" stopFunc=")" paramSeparator="," terminal=";" />
5
6 <KeyWord name="abs" func="yes">
7 <Overload retVal="" descr="
8 Description
9 Returns the absolute value of number.
10
11 Returns
12 Absolute value of number.">
13 <Param name="number" />
14 </Overload>
15 </KeyWord>
16
17 <KeyWord name="AddrInRange" func="yes">
18 <Overload retVal="" descr="
19 Description
20 Checks if given IP address is within given range (including both bounding addresses).
21 All IP addresses should be specified as strings.
22
23 Returns
24 TRUE if address is within given range, FALSE otherwise.">
25 <Param name="address, start, end" />
26 </Overload>
27 </KeyWord>
28
29 <KeyWord name="AddrInSubnet" func="yes">
30 <Overload retVal="" descr="
31 Description
32 Checks if given IP address is within given subnet (including subnet and broadcast addresses).
33
34 Returns
35 TRUE if address is within given subnet, FALSE otherwise.">
36 <Param name="address, subnet, mask" />
37 </Overload>
38 </KeyWord>
39
40 <KeyWord name="AgentReadParameter" func="yes">
41 <Overload retVal="" descr="
42 Description
43 Read parameter's value directly from agent on given node.
44
45 Returns
46 Value of given parameter on success and NULL on failure.">
47 <Param name="node, name" />
48 </Overload>
49 </KeyWord>
50
51 <KeyWord name="AgentReadTable" func="yes">
52 <Overload retVal="" descr="
53 Description
54
55
56 Returns
57 ">
58 <Param name="" />
59 </Overload>
60 </KeyWord>
61
62 <KeyWord name="BindObject" func="yes">
63 <Overload retVal="" descr="
64 Description
65 Bind all NetXMS objects that can be bound from console (nodes, subnets, clusters, and another containers) to container objects.
66
67 Returns
68 Nothing.">
69 <Param name="parent, child" />
70 </Overload>
71 </KeyWord>
72
73 <KeyWord name="ceil" func="yes">
74 <Overload retVal="" descr="
75 Description
76 Round up value.
77
78 Returns
79 The smallest integral value that is not less than x.">
80 <Param name="x" />
81 </Overload>
82 </KeyWord>
83
84 <KeyWord name="chr" func="yes">
85 <Overload retVal="" descr="
86 Description
87 Return a character from it's UNICODE value.
88
89 Returns
90 A character.">
91 <Param name="integer" />
92 </Overload>
93 </KeyWord>
94
95 <KeyWord name="classof" func="yes">
96 <Overload retVal="" descr="
97 Description
98 Returns the class name for given object.
99
100 Returns
101 Object's class name. If parameter passed to this function is not an object, runtime error will be generated.">
102 <Param name="object" />
103 </Overload>
104 </KeyWord>
105
106 <KeyWord name="CreateContainer" func="yes">
107 <Overload retVal="" descr="
108 Description
109 Create container object.
110
111 Returns
112 Reference to newly created object.">
113 <Param name="parent, name" />
114 </Overload>
115 </KeyWord>
116
117 <KeyWord name="CreateDCI" func="yes">
118 <Overload retVal="" descr="
119 Description
120 Create new DCI.
121
122 Returns
123 DCI object on success or NULL on failure.">
124 <Param name="node, source, name, description, dataType, pollingInterval, retentionTime" />
125 </Overload>
126 </KeyWord>
127
128 <KeyWord name="CreateSNMPTransport" func="yes">
129 <Overload retVal="" descr="
130 Description
131 Create new SNMP transport object for specific node. The node must support SNMP.
132
133 Returns
134 Object of class SNMP_Transport or NULL on failure.">
135 <Param name="node" />
136 </Overload>
137 </KeyWord>
138
139 <KeyWord name="DeleteCustomAttribute" func="yes">
140 <Overload retVal="" descr="
141 Description
142 Delete node's custom attribute.
143
144 Returns
145 Nothing.">
146 <Param name="node, attributeName" />
147 </Overload>
148 </KeyWord>
149
150 <KeyWord name="DeleteObject" func="yes">
151 <Overload retVal="" descr="
152 Description
153 Delete object.
154
155 Returns
156 Nothing.">
157 <Param name="object" />
158 </Overload>
159 </KeyWord>
160
161 <KeyWord name="d2x" func="yes">
162 <Overload retVal="" descr="
163 Description
164 Returns the hexidecimal value of a decimal.
165
166 Returns
167 Hexadecimal value of number.">
168 <Param name="number [,padding]" />
169 </Overload>
170 </KeyWord>
171
172 <KeyWord name="exit" func="yes">
173 <Overload retVal="" descr="
174 Description
175 Exit from script.
176
177 Returns
178 Nothing.">
179 <Param name="" />
180 </Overload>
181 </KeyWord>
182
183 <KeyWord name="exp" func="yes">
184 <Overload retVal="" descr="
185 Description
186 Returns e (the base of natural logarithms) raised to a power.
187
188 Returns
189 e^power expressed as a real number.">
190 <Param name="power" />
191 </Overload>
192 </KeyWord>
193
194 <KeyWord name="FindDCIByDescription" func="yes">
195 <Overload retVal="" descr="
196 Description
197 Find DCI by description (search is case-insensetive).
198
199 Returns
200 DCI ID on success or 0 if DCI with matching description was not found.">
201 <Param name="node, description" />
202 </Overload>
203 </KeyWord>
204
205 <KeyWord name="FindDCIByName" func="yes">
206 <Overload retVal="" descr="
207 Description
208 Find DCI by name (search is case-insensetive).
209
210 Returns
211 DCI ID on success or 0 if DCI with matching name was not found.">
212 <Param name="node, description" />
213 </Overload>
214 </KeyWord>
215
216 <KeyWord name="FindNodeObject" func="yes">
217 <Overload retVal="" descr="
218 Description
219 Find node object by node id or node name.
220
221 Returns
222 Node object with given id or name on success or NULL on failure (either because node with given name/id does not exist, or access to it was denied).">
223 <Param name="node, id" />
224 </Overload>
225 </KeyWord>
226
227 <KeyWord name="FindObject" func="yes">
228 <Overload retVal="" descr="
229 Description
230 Find NetXMS object by object id or name.
231
232 Returns
233 Node object with given id or name on success or NULL on failure (either because object with given name/id does not exist, or access to it was denied).">
234 <Param name="id, node" />
235 </Overload>
236 </KeyWord>
237
238 <KeyWord name="FindSituation" func="yes">
239 <Overload retVal="" descr="
240 Description
241 Find situation instance either by situation object name and instance name or by situation object ID and instance name (name search is case-insensetive).
242
243 Returns
244 Situation object with given ID or name on success or NULL on failure.">
245 <Param name="id, instance" />
246 </Overload>
247 </KeyWord>
248
249 <KeyWord name="floor" func="yes">
250 <Overload retVal="" descr="
251 Description
252 Round down value.
253
254 Returns
255 The largest integral value not greater than x.">
256 <Param name="x" />
257 </Overload>
258 </KeyWord>
259
260 <KeyWord name="format" func="yes">
261 <Overload retVal="" descr="
262 Description
263 Formats a numeric value.
264
265 Returns
266 Formatted numeric value.">
267 <Param name="number, width, precision" />
268 </Overload>
269 </KeyWord>
270
271 <KeyWord name="GetAvgDCIValue" func="yes">
272 <Overload retVal="" descr="
273 Description
274 Get the average value of the DCI for the given period. The DCI value must be of numeric type.
275
276 Returns
277 Average value or NULL on failure.">
278 <Param name="node, dciId, from, to" />
279 </Overload>
280 </KeyWord>
281
282 <KeyWord name="GetConfigurationVariable" func="yes">
283 <Overload retVal="" descr="
284 Description
285 Get value of server's configuration variable.
286
287 Returns
288 Value of requested variable or specified default value if given variable is not set.">
289 <Param name="variableName, [defaultValue]" />
290 </Overload>
291 </KeyWord>
292
293 <KeyWord name="GetCustomAttribute" func="yes">
294 <Overload retVal="" descr="
295 Description
296 Get value of node's custom attribute.
297 If attribute name conforms to NXSL identifier naming conventions, it can be accessed directly as node object attribute.
298 For example &quot;GetCustomAttribute($node, &quot;my_attribute&quot;)&quot; can be changed to &quot;$node-&gt;my_attribute&quot;.
299
300 Returns
301 String value of requested custom attribute or NULL if attribute is missing.">
302 <Param name="node, attributeName" />
303 </Overload>
304 </KeyWord>
305
306 <KeyWord name="GetDCIObject" func="yes">
307 <Overload retVal="" descr="
308 Description
309 Get DCI object with given ID.
310
311 Returns
312 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).">
313 <Param name="node, id" />
314 </Overload>
315 </KeyWord>
316
317 <KeyWord name="GetDCIRawValue" func="yes">
318 <Overload retVal="" descr="
319 Description
320 Get last raw value (before transformation) of DCI with given ID on given node.
321
322 Returns
323 Last raw value (before transformation) for given DCI or NULL if DCI with given ID does not exist or has no collected values.">
324 <Param name="node, id" />
325 </Overload>
326 </KeyWord>
327
328 <KeyWord name="GetDCIValue" func="yes">
329 <Overload retVal="" descr="
330 Description
331 Get last value of DCI with given ID on given node.
332
333 Returns
334 Last value for given DCI or NULL if DCI with given ID does not exist or has no collected values.">
335 <Param name="node, id" />
336 </Overload>
337 </KeyWord>
338
339 <KeyWord name="GetDCIValueByDescription" func="yes">
340 <Overload retVal="" descr="
341 Description
342 Get last value of DCI with given description on given node.
343
344 Returns
345 Last value for given DCI or NULL if DCI with given description does not exist or has no collected values.">
346 <Param name="node, description" />
347 </Overload>
348 </KeyWord>
349
350 <KeyWord name="GetDCIValueByName" func="yes">
351 <Overload retVal="" descr="
352 Description
353 Get last value of DCI with given name on given node.
354
355 Returns
356 Last value for given DCI or NULL if DCI with given name does not exist or has no collected values.">
357 <Param name="node, name" />
358 </Overload>
359 </KeyWord>
360
361 <KeyWord name="GetEventParameter" func="yes">
362 <Overload retVal="" descr="
363 Description
364 Get value of event's named parameter.
365
366 Returns
367 String value of requested parameter or NULL if no such parameter exist.">
368 <Param name="event, parameterName" />
369 </Overload>
370 </KeyWord>
371
372 <KeyWord name="GetInterfaceName" func="yes">
373 <Overload retVal="" descr="
374 Description
375 Get interface name by index.
376
377 Returns
378 Name of the requested interface or null if not found.">
379 <Param name="obj, index" />
380 </Overload>
381 </KeyWord>
382
383 <KeyWord name="GetInterfaceObject" func="yes">
384 <Overload retVal="" descr="
385 Description
386 Get interface object by index.
387
388 Returns
389 An interface object, or null if not found.">
390 <Param name="obj, index" />
391 </Overload>
392 </KeyWord>
393
394 <KeyWord name="GetMaxDCIValue" func="yes">
395 <Overload retVal="" descr="
396 Description
397 Get the maximum value of the DCI for the given period. The DCI value must be of numeric type.
398
399 Returns
400 Maximum value or NULL on failure.">
401 <Param name="node, dciId, from, to" />
402 </Overload>
403 </KeyWord>
404
405 <KeyWord name="GetMinDCIValue" func="yes">
406 <Overload retVal="" descr="
407 Description
408 Get the minimum value of the DCI for the given period. The DCI value must be of numeric type.
409
410 Returns
411 Minimum value or NULL on failure.">
412 <Param name="node, dciId, from, to" />
413 </Overload>
414 </KeyWord>
415
416 <KeyWord name="GetNodeInterfaces" func="yes">
417 <Overload retVal="" descr="
418 Description
419 Get all interfaces for given node.
420
421 Returns
422 Array of objects of class Interface, with first object placed at index 0. End of list indicated by array element with NULL value.">
423 <Param name="node" />
424 </Overload>
425 </KeyWord>
426
427 <KeyWord name="GetNodeParents" func="yes">
428 <Overload retVal="" descr="
429 Description
430 Get accessible parent objects for given node.
431
432 Returns
433 Array of objects of class NetObj (generic NetXMS object), with first object placed at index 0.
434 End of list indicated by array element with NULL value.
435 This function will never return template or policy objects applied to node.
436 Return value also affected by trusted nodes settings (see &quot;Security Issues&quot; on wiki for more information).">
437 <Param name="node" />
438 </Overload>
439 </KeyWord>
440
441 <KeyWord name="GetObjectChildren" func="yes">
442 <Overload retVal="" descr="
443 Description
444 Get accessible child objects for given object.
445
446 Returns
447 Array of objects of class Node, Interface, or NetObj, with first object placed at index 0.
448 End of list indicated by array element with NULL value.
449 Return value also affected by trusted nodes settings (see &quot;Security Issues&quot; on wiki for more information).">
450 <Param name="object" />
451 </Overload>
452 </KeyWord>
453
454 <KeyWord name="GetObjectParents" func="yes">
455 <Overload retVal="" descr="
456 Description
457 Get accessible parent objects for given object.
458
459 Returns
460 Array of objects of class NetObj (generic NetXMS object), with first object placed at index 0.
461 End of list indicated by array element with NULL value.
462 This function will never return template or policy objects applied to node.
463 Return value also affected by trusted nodes settings (see &quot;Security Issues&quot; on wiki for more information).">
464 <Param name="object" />
465 </Overload>
466 </KeyWord>
467
468 <KeyWord name="GetSumDCIValue" func="yes">
469 <Overload retVal="" descr="
470 Description
471 Get the sum value of the DCI for the given period. The DCI value must be of numeric type.
472
473 Returns
474 Sum value or NULL on failure.">
475 <Param name="node, dciId, from, to" />
476 </Overload>
477 </KeyWord>
478
479 <KeyWord name="GetSituationAttribute" func="yes">
480 <Overload retVal="" descr="
481 Description
482
483
484 Returns
485 ">
486 <Param name="" />
487 </Overload>
488 </KeyWord>
489
490 <KeyWord name="gmtime" func="yes">
491 <Overload retVal="" descr="
492 Description
493 Converts time in UNIX format (number of seconds since epoch) to calendar date and time broken down into its components, expressed as UTC (or GMT timezone).
494 Function uses either time given in time argument or current time if time is omitted.
495
496 Returns
497 Object of class TIME.">
498 <Param name="time" />
499 </Overload>
500 </KeyWord>
501
502 <KeyWord name="index" func="yes">
503 <Overload retVal="" descr="
504 Description
505 Returns the position of the first occurrence of substring in string at or after position if specifed.
506 All index values are 1-based (i.e. the first character has index 1, not 0).
507
508 Returns
509 Integer value of the position substring was found at, will return 0 if not found.">
510 <Param name="string, substring [,position]" />
511 </Overload>
512 </KeyWord>
513
514 <KeyWord name="inList" func="yes">
515 <Overload retVal="" descr="
516 Description
517 Check if given value is an element of given list.
518
519 Returns
520 TRUE if given value is an element of given list, FALSE otherwise.">
521 <Param name="string, separator, value" />
522 </Overload>
523 </KeyWord>
524
525 <KeyWord name="left" func="yes">
526 <Overload retVal="" descr="
527 Description
528 Returns the string of length characters of string, optionally padded with pad character instead of a space.
529
530 Returns
531 String of the left length characters.">
532 <Param name="string, length [,pad]" />
533 </Overload>
534 </KeyWord>
535
536 <KeyWord name="length" func="yes">
537 <Overload retVal="" descr="
538 Description
539 Returns the length of string.
540
541 Returns
542 Integer length of the string passed to the function.">
543 <Param name="string" />
544 </Overload>
545 </KeyWord>
546
547 <KeyWord name="localtime" func="yes">
548 <Overload retVal="" descr="
549 Description
550 Converts time in UNIX format (number of seconds since epoch) to calendar date and time broken down into its components. Function uses either time given in time argument or current time if time is omitted.
551
552 Returns
553 Object of class TIME.">
554 <Param name="time" />
555 </Overload>
556 </KeyWord>
557
558 <KeyWord name="log" func="yes">
559 <Overload retVal="" descr="
560 Description
561 Calculates natural logarithm of given value.
562
563 Returns
564 Natural logarithm of x.">
565 <Param name="x" />
566 </Overload>
567 </KeyWord>
568
569 <KeyWord name="log10" func="yes">
570 <Overload retVal="" descr="
571 Description
572 Calculates logarithm of given value to base 10.
573
574 Returns
575 Logarithm of x to base 10.">
576 <Param name="x" />
577 </Overload>
578 </KeyWord>
579
580 <KeyWord name="lower" func="yes">
581 <Overload retVal="" descr="
582 Description
583 Converts string to lowercase.
584
585 Returns
586 Source string converted to lowercase.">
587 <Param name="string" />
588 </Overload>
589 </KeyWord>
590
591 <KeyWord name="ltrim" func="yes">
592 <Overload retVal="" descr="
593 Description
594 Removes blanks (space and tab characters) from the left side of specified string.
595
596 Returns
597 Source string with blanks at the left side removed.">
598 <Param name="string" />
599 </Overload>
600 </KeyWord>
601
602 <KeyWord name="ManageObject" func="yes">
603 <Overload retVal="" descr="
604 Description
605 Set object into managed state. Has no effect if object is already in managed state.
606
607 Returns
608 Nothing.">
609 <Param name="object" />
610 </Overload>
611 </KeyWord>
612
613 <KeyWord name="map" func="yes">
614 <Overload retVal="" descr="
615 Description
616 Returns the value which corresponds to a specified key from specified Mapping Table.
617
618 Returns
619 Value corresponding for a keyName from tableName.">
620 <Param name="tableName, keyName" />
621 </Overload>
622 </KeyWord>
623
624 <KeyWord name="max" func="yes">
625 <Overload retVal="" descr="
626 Description
627 Returns maximal value from a list of values.
628
629 Returns
630 Maximal value of numbers.">
631 <Param name="number1 [,number2] [,number n]" />
632 </Overload>
633 </KeyWord>
634
635 <KeyWord name="min" func="yes">
636 <Overload retVal="" descr="
637 Description
638 Returns minimal value from a list of values.
639
640 Returns
641 Minimal value of numbers.">
642 <Param name="number1 [,number2] [,number n]" />
643 </Overload>
644 </KeyWord>
645
646 <KeyWord name="ord" func="yes">
647 <Overload retVal="" descr="
648 Description
649 Convert a character into it's ASCII/Unicode value.
650 Only processes one character.
651
652 Returns
653 An ASCII/Unicode value.">
654 <Param name="character" />
655 </Overload>
656 </KeyWord>
657
658 <KeyWord name="PostEvent" func="yes">
659 <Overload retVal="" descr="
660 Description
661 Post event on behalf of given node.
662 &quot;...&quot; - 0 or more event-specific parameters.
663
664 Returns
665 TRUE if event was posted successfully or FALSE if not.">
666 <Param name="node, event, tag, ..." />
667 </Overload>
668 </KeyWord>
669
670 <KeyWord name="pow" func="yes">
671 <Overload retVal="" descr="
672 Description
673 Calculates x raised to the power of y.
674
675 Returns
676 x raised to the power of y.">
677 <Param name="x, y" />
678 </Overload>
679 </KeyWord>
680
681 <KeyWord name="random" func="yes">
682 <Overload retVal="" descr="
683 Description
684 Generate pseudo random number in given range. Uses c/c++ rand() function.
685
686 Returns
687 Random value in range minValue..maxValue.">
688 <Param name="minValue, maxValue" />
689 </Overload>
690 </KeyWord>
691
692 <KeyWord name="RenameObject" func="yes">
693 <Overload retVal="" descr="
694 Description
695 Rename object.
696
697 Returns
698 Nothing.">
699 <Param name="object, name" />
700 </Overload>
701 </KeyWord>
702
703 <KeyWord name="right" func="yes">
704 <Overload retVal="" descr="
705 Description
706 Returns the string of length characters of string, optionally padded with pad character instead of blank (space) starting from the right. Padding occurs on the left portion of the string.
707
708 Returns
709 String of the right length characters.">
710 <Param name="string, length [,pad]" />
711 </Overload>
712 </KeyWord>
713
714 <KeyWord name="rindex" func="yes">
715 <Overload retVal="" descr="
716 Description
717 Returns the position of the last occurrence of substring in string up to or before position if specifed.
718
719 Returns
720 Integer value of the position substring was found at, will return 0 if not found.">
721 <Param name="string, substring [,position]" />
722 </Overload>
723 </KeyWord>
724
725 <KeyWord name="round" func="yes">
726 <Overload retVal="" descr="
727 Description
728 Round floating point value to the nearest integral value or floating point value with given precision.
729 [precision] - optional number of decimal places to be left. If omited or set to 0, x will be rounded to integral value.
730
731 Returns
732 The integral value that is closest to x if precision is omited or set to 0, or floating point value rounded to have given number of decimal places.">
733 <Param name="x [, precision]" />
734 </Overload>
735 </KeyWord>
736
737 <KeyWord name="rtrim" func="yes">
738 <Overload retVal="" descr="
739 Description
740 Removes blanks (space and tab characters) from the right side of specified string.
741
742 Returns
743 Source string with blanks at the right side removed.">
744 <Param name="string" />
745 </Overload>
746 </KeyWord>
747
748 <KeyWord name="sleep" func="yes">
749 <Overload retVal="" descr="
750 Description
751 Suspend script execution for given number of milliseconds.
752
753 Returns
754 Nothing.">
755 <Param name="milliseconds" />
756 </Overload>
757 </KeyWord>
758
759 <KeyWord name="SecondsToUptime" func="yes">
760 <Overload retVal="" descr="
761 Description
762 Format system uptime in seconds as string in format &quot;n days, hh:mm&quot;.
763
764 Returns
765 System uptime in format &quot;n days, hh:mm&quot;.">
766 <Param name="seconds" />
767 </Overload>
768 </KeyWord>
769
770 <KeyWord name="SetCustomAttribute" func="yes">
771 <Overload retVal="" descr="
772 Description
773 Set value of node's custom attribute. If attribute was not defined, it will be created.
774
775 Returns
776 Previous value of requested custom attribute or NULL if attribute was not defined before.">
777 <Param name="node, attributeName, value" />
778 </Overload>
779 </KeyWord>
780
781 <KeyWord name="SetEventParameter" func="yes">
782 <Overload retVal="" descr="
783 Description
784 Set value of event's named parameter.
785
786 Returns
787 Nothing.">
788 <Param name="event, parameterName, value" />
789 </Overload>
790 </KeyWord>
791
792 <KeyWord name="SetInterfaceExpectedState" func="yes">
793 <Overload retVal="" descr="
794 Description
795 Set expected state for given interface.
796
797 Returns
798 Nothing.">
799 <Param name="interface, state" />
800 </Overload>
801 </KeyWord>
802
803 <KeyWord name="SNMPGet" func="yes">
804 <Overload retVal="" descr="
805 Description
806 Get the object value from specific node with SNMP GET request.
807 The node and all SNMP communication details defined by SNMP transport.
808
809 Returns
810 Object of class SNMP_VarBind or NULL on failure.">
811 <Param name="transport,oid" />
812 </Overload>
813 </KeyWord>
814
815 <KeyWord name="SNMPGetValue" func="yes">
816 <Overload retVal="" descr="
817 Description
818 Get the object value from specific node with SNMP GET request.
819 The node and all SNMP communication details defined by SNMP transport.
820 This function is similar to SNMPGet but returns string instead of an SNMP_VarBind object.
821
822 Returns
823 String with the value requested or NULL on failure.">
824 <Param name="transport,oid" />
825 </Overload>
826 </KeyWord>
827
828 <KeyWord name="SNMPSet" func="yes">
829 <Overload retVal="" descr="
830 Description
831 Assign a specific value to the given SNMP object for the node.
832 The node and all SNMP communication details defined by SNMP transport.
833
834 Returns
835 TRUE on success, FALSE in case of failure.">
836 <Param name="transport,oid,value,[data type]" />
837 </Overload>
838 </KeyWord>
839
840 <KeyWord name="SNMPWalk" func="yes">
841 <Overload retVal="" descr="
842 Description
843 Get an array of the object values from specific node with SNMP WALK request.
844 The node and all SNMP communication details defined by SNMP transport.
845
846 Returns
847 Array of SNMP_VarBind objects or NULL on failure.">
848 <Param name="transport,oid" />
849 </Overload>
850 </KeyWord>
851
852 <KeyWord name="strftime" func="yes">
853 <Overload retVal="" descr="
854 Description
855
856
857 Returns
858 ">
859 <Param name="" />
860 </Overload>
861 </KeyWord>
862
863 <KeyWord name="substr" func="yes">
864 <Overload retVal="" descr="
865 Description
866 Extracts the substring from string that begins at the nth character and is of length len.
867
868 Returns
869 Extracted substring.">
870 <Param name="string, n[, len]" />
871 </Overload>
872 </KeyWord>
873
874 <KeyWord name="time" func="yes">
875 <Overload retVal="" descr="
876 Description
877 Gets the system time.
878
879 Returns
880 System time as number of seconds elapsed since midnight (00:00:00), January 1, 1970, coordinated universal time, according to the system clock (also known as UNIX time).">
881 <Param name="" />
882 </Overload>
883 </KeyWord>
884
885 <KeyWord name="trace" func="yes">
886 <Overload retVal="" descr="
887 Description
888 Writes message to netxms main log at given debug level.
889
890 Returns
891 Nothing.">
892 <Param name="debugLevel, message" />
893 </Overload>
894 </KeyWord>
895
896 <KeyWord name="trim" func="yes">
897 <Overload retVal="" descr="
898 Description
899 Removes blanks (space and tab characters) from both sides of specified string.
900
901 Returns
902 Source string with blanks at both sides removed.">
903 <Param name="string" />
904 </Overload>
905 </KeyWord>
906
907 <KeyWord name="typeof" func="yes">
908 <Overload retVal="" descr="
909 Description
910 Returns the data type for given value.
911
912 Returns
913 data type for given value. Type is returned as lowercase string. The following type names can be returned:
914 NULL
915 object
916 string
917 real
918 int32
919 int64
920 uint32
921 uint64">
922 <Param name="value" />
923 </Overload>
924 </KeyWord>
925
926 <KeyWord name="UnbindObject" func="yes">
927 <Overload retVal="" descr="
928 Description
929 Remove (unbind) object from a container.
930
931 Returns
932 Nothing.">
933 <Param name="parent, child" />
934 </Overload>
935 </KeyWord>
936
937 <KeyWord name="UnmanageObject" func="yes">
938 <Overload retVal="" descr="
939 Description
940 Set object into unmanaged state. Has no effect if object is already in unmanaged state.
941
942 Returns
943 Nothing.">
944 <Param name="object" />
945 </Overload>
946 </KeyWord>
947
948 <KeyWord name="upper" func="yes">
949 <Overload retVal="" descr="
950 Description
951 Converts string to uppercase.
952
953 Returns
954 Source string converted to uppercase.">
955 <Param name="string" />
956 </Overload>
957 </KeyWord>
958
959 </AutoComplete>
960 </NotepadPlus>