template::form::set_error (public)

 template::form::set_error id element error

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

Set an error on a form element. Can be called from the -on_submit or -after_submit block of an ad_form. Will cause the form to no longer be considered valid, and thus the form will be redisplayed with the error message embedded, provided that 'break' is also called, so any code that redirects away from the form (e.g. in the after_submit block) isn't called either.

Parameters:

id (required)

The ID of the form

element (required)

The element that contains the error.

error (required)

The error message.

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

Testcases:

No testcase defined.

Source code:

    # use an array to hold error messages for this form
    upvar #[template::adp_level] $id:error formerror

    set formerror($element) $error

XQL Not present:

Generic, PostgreSQL, Oracle