Programmer's Guide (Supporting ADX v03.1.00) Manual

138 Brocade Virtual ADX XML API Programmer’s Guide
53-1003248-01
Data structures
3
screenPositionIndex unsignedInt Optional 0 means
undefined
If non-zero, this is a
hint for
user-interface clients
about where on the
screen this
variable's input field
should be placed.
shortPrompt string Optional 64 characters
maximum
A hint for
user-interface clients
about how this
variable's input field
should be prompted.
longHelpText string Optional 256 characters
maximum
A hint for
user-interface clients
about what help text
to display.
defaultValue string Optional 256 characters
maximum
When read, the
default value to
show a user in an
input field; when
written, the actual
value to be applied
to the template
when executed.
visual boolean Optional A hint for
user-interface
clients: if true, the
variable should be
shown to the user as
an input field.
autoIncrement boolean Optional If true, the variable
value will be
incremented with
each iteration within
an ADX template
"repeater."
includeConditionally string Optional 32 characters
maximum; the
name of another
variable
If non-blank, then
this variable should
only be shown to the
user for input if the
referenced variable
is boolean with a
"true" value.
allowBlank boolean
fetchFromService string
TABLE 331 TemplateVariable attributes (Continued)
Name Type Presence Rules Description