Difference between revisions of "Activity:DebugMessage (Activity)"
(Created page with "{{ActivityInfoBox | title = DebugMessage | name = Workflow Editor | internalname = CtrlWorkflowEditor | image = 220px | imagecaption = Workflow ...") |
|||
| (34 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | The DebugMessage Activity writes a string to the {{UBIK}} debugging service, which is i.e. displayed in the [[Debugger|Code- and Workflow Debugger]]. | ||
| + | = Description = | ||
{{ActivityInfoBox | {{ActivityInfoBox | ||
| − | | title = | + | | title = Debug Message |
| − | | name = | + | | name = DebugMessage |
| − | + | | image = | |
| − | | image = | + | | imagecaption = Activity DebugMessage |
| − | | imagecaption = | + | | purpose = Output a string to the debug window |
| − | | purpose = | + | |
| category = Debugging | | category = Debugging | ||
| − | | returns = True if | + | | returns = True if successful |
| version = 2.1+ | | version = 2.1+ | ||
}} | }} | ||
| + | ===Arguments=== | ||
| + | |||
| + | {| class="wikitable sortable" | width = "50%" | ||
| + | |- | ||
| + | ! Argument!! Type !! Direction !! Purpose | ||
| + | |- align="left" | ||
| + | | UBIKObject|| [[BaseClass]] || In || A UBIK object | ||
| + | |- align="left" | ||
| + | | Text || {{String_MSDN}} || In || The string to be written to the debugging service | ||
| + | |- align="left" | ||
| + | | Result|| {{Boolean_MSDN}} || Out || Returns True on success, false on error | ||
| + | |} | ||
| + | |||
| + | ===Usage=== | ||
| + | |||
| + | This activity is typically used to output debug information like variable values, object properties etc. during the execution of a workflow. | ||
| + | |||
| + | {{Hint|Once your workflow runs smoothly, consider removing the DebugActivities you used during design. They are lean but they still consume resources!}} | ||
| + | |||
| + | =Example= | ||
| + | Output the number of MetaClasses that derive (direct and indirect) from the MetaClass of a given object: | ||
| + | |||
| + | {| class="wikitable" | width = "50%" | ||
| + | |- | ||
| + | ! Argument!! Value | ||
| + | |- align="left" | ||
| + | | UBIKObject|| Connect this argument with a variable | ||
| + | |- align="left" | ||
| + | | Text || <source lang = "vbnet">UBIKObject.MetaClass.AllDerivates.Count.ToString()</source> | ||
| + | |} | ||
| + | |||
| + | {{Activity/End}} | ||
| + | |||
| + | ==See also== | ||
| + | * [[Workflow Designer]] | ||
| + | |||
| + | [[Category:Activities]] | ||
Latest revision as of 10:23, 19 March 2015
The DebugMessage Activity writes a string to the UBIK® debugging service, which is i.e. displayed in the Code- and Workflow Debugger.
[edit]
Description
| Debug Message | |
|---|---|
| Name | DebugMessage |
| Purpose | Output a string to the debug window |
| Category | Debugging |
| Returns | True if successful |
| Version | 2.1+ |
Arguments
| Argument | Type | Direction | Purpose |
|---|---|---|---|
| UBIKObject | BaseClass | In | A UBIK object |
| Text | String | In | The string to be written to the debugging service |
| Result | Boolean | Out | Returns True on success, false on error |
Usage
This activity is typically used to output debug information like variable values, object properties etc. during the execution of a workflow.
 | Once your workflow runs smoothly, consider removing the DebugActivities you used during design. They are lean but they still consume resources! |
Example
Output the number of MetaClasses that derive (direct and indirect) from the MetaClass of a given object:
| Argument | Value |
|---|---|
| UBIKObject | Connect this argument with a variable |
| Text | UBIKObject.MetaClass.AllDerivates.Count.ToString() |
