Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Comment:
Migrated to Confluence 5.3
Excerpt |
---|
Message output handler. |
Syntax
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
uOut(sMsg_aMsg, oSelf, cOutout(message[, sdo[, method[, config]]]); |
Parameters
Parameter | Type | Mandatory | Description | Util.js version | sMsg_aMsgAPI Version | |||
---|---|---|---|---|---|---|---|---|
message | String Array of String | The message to output – either a single string or an array of strings. | 1.0.8 | |||||
oSelfsdo | Self Descriptor Object | Optional descriptor object, used to create a prefix to the message before it is output. Example object: | 0.8 | cOut If you're using the method or config params, but don't want to use an SDO, specify Default: No prefix | 1.0 | |||
method | Constant | Constant defining desired output destination:
Default: | 1.0.8 | |||||
config | Variant | Optional method-specific config:
| 1.0 |
Return value
The return value of the output method will be returned (see documentation for OUT_out.*
constants above for more information).
Example
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
var self = {file: "foo.js", ver: 1.2}; function bar() { uOut("bar() called out("hello", self, OUT_out.CONSOLE); } bar(); // "[foo.js v1.2] bar() calledhello" |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
function foo() { var names = out(["bob", "jim", "kate"]; uOut(names); } foo(); // outputs each of the namesname on a new line to OUT_out.DEFAULT |
Div | ||||||
---|---|---|---|---|---|---|
| ||||||
Availability
This feature requires:
|
Div | ||||
---|---|---|---|---|
| ||||
ContentsJump to:
|
Div | ||
---|---|---|
| ||
See alsoRelated articles:
Related APIs: |
Div | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
GlobalsTopics:
|