JavaScript global method: help

Displays a brief description of a Service Manager-defined JavaScript object.

Syntax

help( object );

Arguments

The following arguments are valid for this function:

Argument Data type Required Description
object Service Manager-defined JavaScript object Yes This argument contains the Service Manager-defined JavaScript object for which you want a brief description.

Return values

A string or null.

This method returns a brief text string describing the Service Manager-defined JavaScript object or null if there is no help available.

Throws

None

Description

This method displays a brief description of a Service Manager-defined JavaScript object. You must use the print() method to see the help text string.

Example

This example displays the help contents of several Service Manager-defined JavaScript objects.

var f = new SCFile();
print( help( f ) );
var x = new XML();
print( help( x ) );
var d = new XMLDate();
print( help( d ) );