template::multirow (public)
template::multirow [ -ulevel ulevel ] [ -local ] [ -unclobber ] \
command name [ args... ]Defined in packages/acs-templating/tcl/query-procs.tcl
Create/Manipulate a multirow datasource (for use with <multiple> tags)
- template::multirow create datasourcename column [column ...]
- creates a multirow datasource of datasourcename
- template::multirow extend datasourcename column [column ...]
- extend adds a column to an existing multirow
- template::multirow append datasourcename value [value ...]
- appends the row to an existing multirow.
- template::multirow pop datasourcename
- pops a row off an existing multirow, returning a list of the rows keys gand values
- template::multirow size datasourcename
- returns the rowcount
- template::multirow columns datasourcename
- returns the columns in the datasource
- template::multirow get datasourcename rownum [column]
- returns the row of data (or the particular row/column if column is provided)
- template::multirow set datasourcename rownum column value
- set an element value
- template::multirow foreach datasource code
- evaluate code block for each row (like db_foreach)
- template::multirow upvar datasource [new_name]
- upvar the multirow, aliasing to new_name if provided
- template::multirow unset datasource
- unset multirow
- template::multirow sort datasource -lsort-switch col1 col2
- Sort the multirow by the column(s) specified. The value sorted by will be the values of the columns specified, separated by the space character. Any switches specified before the columns will be passed directly to the lsort command.
- template::multirow exists datasource
- Return 1 if the multirow datasource exists, 0 if it doesn't.
- Switches:
- -ulevel (optional, defaults to
"1")- Used in conjunction with the "local" parameter to specify how many levels up the multirow variable resides.
- -local (optional, boolean)
- If set, the multirow will be looked for in the scope the number of levels up given by ulevel (normally the caller's scope), instead of the
[template::adp_level]scope, which is the default.- -unclobber (optional, boolean)
- This only applies to the 'foreach' command. If set, will cause the proc to not overwrite local variables. Actually, what happens is that the local variables will be overwritten, so you can access them within the code block. However, if you specify -unclobber, we will revert them to their original state after execution of this proc.
- Parameters:
- command (required)
- Multirow datasource operation: create, extend, append, pop, size, get, set, foreach, upvar
- name (required)
- Name of the multirow datasource
- See Also:
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- db__transaction_bug_3440, util_user_messages, templates_and_scripts
