| Excerpt |
|---|
Run a diagnostic. |
Syntax
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
var result = Diag.run(name, params); // run a diagnostic |
Parameters
| Parameter | Type | Mandatory | Notes | Diag Ver |
|---|---|---|---|---|
| name | String |  | Name of the diagnostic routine.
| 1.0 |
| params | Variant |  | Any additional parameters to pass in to the routine.
| 1.0 |
Return values
| Value | Type | Notes | Diag Ver |
|---|---|---|---|
| <string> | String | The results of the diagnostic in a single string. | 1.0 |
| <array> | Array of String | The results of the diagnostic in an array of strings (or values that will reliably typecast to strings). | 1.0 |
| <error> | String | If something goes wrong, the error message will be returned as a string. | 1.0 |
Example
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
// define a diagnostic routine function var myDiagFn = function bar(name, param1, param2, etc) { // name always converted to lowercase // return arguments object converted in to an array return Array.prototype.splice.call(arguments); } Diag.add("foo", myDiagFn); // register myDiagFn under the name "foo" Diag("Foo", true, "bleh"); // ["foo", true, "bleh"] |
Notes
See Diag.add() for notes about diagnostic routine functions.