ph_webds PowerHome formula function
Description
Returns a dynamic HTML table containing the PowerHome Device Status screen.
Syntax
ph_webds (
dstype, location, filter, sort, nexturl, cols )
Argument |
Description |
dstype
|
Integer. The type of web based Device Status screen to return. Currently only a value of 0 is supported.
|
location |
String. Filter the device status list by location. Use empty
string "" to return all. |
filter |
String. Filter the device status list with a user defined
filter. Use empty string "" to not filter. |
sort |
String. Sort the device status list using a user defined
sort. Use empty string "" to retain the default sort. |
nexturl |
String. A string representing the URL of the next page to
open after processing a device status control button. |
cols
|
String. A string the columns and column order that would like used in the HTML table. See Usage below.
|
Return value
String. Returns a complete HTML table source code for the PowerHome Device Status screen at that moment.
Usage
Use this function to quickly
incorporate the Device Status screen directly
into your own PSP code creations with virtually no coding. Using this function, you can create
your own menus and mix or match individual PowerHome web
elements.
See the table below for the available columns to use in
the cols parameter:
1 |
Control |
2 |
Status |
3 |
Device Name |
4 |
Location |
5 |
Type |
6 |
ID |
7 |
Last Change |
Leave the
"cols" parameter blank to accept the default columns and order. This will be equivalent
to "1,2,3,4,5,6,7".
Examples
The following examples demonstrate typical syntax/usage for this function.
ph_webds(0,"Family
Room","","","ds.psp","2,1,3,7") - Generates a version of the Device Status
screen that displays only devices with a location of Family Room and only shows
the columns of Status, Control, Device Name, and Last Change in that order. If
any Control options are used on this screen, the reload page will be "ds.psp"
(typically the file that is used to create this screen in the first
place).