Searching the Help
To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.
Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.
Words and Phrases
| Search for | Example | Results |
|---|---|---|
| A single word | cat
|
Topics that contain the word "cat". You will also find its grammatical variations, such as "cats". |
|
A phrase. You can specify that the search results contain a specific phrase. |
"cat food" (quotation marks) |
Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase. |
Using Boolean Operators
| Search for | Operator | Example |
|---|---|---|
|
Two or more words in the same topic |
|
|
| Either word in a topic |
|
|
| Topics that do not contain a specific word or phrase |
|
|
| Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
| A combination of search types | ( ) parentheses |
|
- List: JavaScript global methods
- JavaScript global method: base64Decode
- JavaScript global method: base64Encode
- JavaScript global method: compile
- JavaScript global method: doHTTPRequest
- JavaScript global method: doSOAPRequest
- JavaScript global method: execute
- JavaScript global method: getLog
- JavaScript global method: help
- JavaScript global method: insertDatum
- JavaScript global method: makeSCWebURL
- JavaScript global method: print
- JavaScript global method: Quit
- JavaScript global method: RCtoString
- JavaScript global method: readFile
- JavaScript global method: setAppMessage
- JavaScript global method: stripHtml
- JavaScript global method: uncompressFile
- JavaScript global method: writeAttachmentToFile
- JavaScript global method: writeFile
- JavaScript global method: xmlstring
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 ) );
