| 268. Summary | ||
|---|---|---|
 |  | |
| 268. Summary | ||
|---|---|---|
| | | |
Support for summaries of the configured devices
List of Global Functions
AddHeader - Add a RichText section header to an existing summary.
AddLine - Add a line to an existing summary.
AddListItem - Add a list item to an existing summary. Requires a previous call to 'summaryOpenList()'.
AddNewLine - Add a newline to an existing summary.
AddSimpleSection - Add a simple section to an existing summary, consisting of a header and one single item.
CloseList - End a list within a summary.
Device - Function that creates description of one device.
DevicesList - Function that creates the whole final product. "Not detected" will be returned if the list is empty.
NotConfigured - Function that creates a 'Not configured.' message.
OpenList - Start a list within a summary.
List of Global Variables
Add a RichText section header to an existing summary.
Function parameters
string summary
string header
Return value
string - the new summary including the new header
Add a line to an existing summary.
Function parameters
string summary
string line
Return value
string - the new summary including the new line
Add a list item to an existing summary. Requires a previous call to 'summaryOpenList()'.
Function parameters
string summary
string item
Return value
string - the new summary including the new line
Add a newline to an existing summary.
Function parameters
string summary
Return value
string - the new summary
Add a simple section to an existing summary, consisting of a header and one single item.
Function parameters
string summary
string header
string item
Return value
string - the new summary including the new line
End a list within a summary.
Function parameters
string summary
Return value
string - the new summary
Function that creates description of one device.
Function parameters
string name
string description
Return value
string - String with the item.
Function that creates the whole final product. "Not detected" will be returned if the list is empty.
Function parameters
list<string> devices
Return value
string - The resulting text.
Function that creates a 'Not configured.' message.
Return value
string - String with the message.
| | | |
| 267. Sudo |  | 269. Support |