template::request::set_param (public)

 template::request::set_param name [ args... ]

Defined in packages/acs-templating/tcl/request-procs.tcl

Declares a query parameter as part of the page request. Validates the values associated with the parameter, in the same fashion as for form elements.

Parameters:

name (required)

The name of the parameter to declare.

Options:

-name

The name of parameter in the query (may be different from the reference name).

-multiple

A flag indicating that multiple values may be specified for this parameter.

-datatype

The name of a datatype for the element values. Valid datatypes must have a validation procedure defined in the template::data::validate namespace.

-optional

A flag indicating that no value is required for this element. If a default value is specified, the default is used instead.

-validate

A list of custom validation blocks in the form { name { expression } { message } name { expression } { message } ...} where name is a unique identifier for the validation step, expression is a block to Tcl code that evaluates to 1 or 0, and message is to be displayed to the user when the validation step fails.

See Also:

• template::element::create

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Source code:

    set level [template::adp_level]
    template::element::create request $name {*}$args

    # Set a local variable with the parameter value but no
    # clobber the variable if it already exists.

    uplevel #$level "
        if { ! \[info exists $name\] } {
            set $name \[template::request::get_param $name\]
        }
    "

XQL Not present:

Generic, PostgreSQL, Oracle