TclMML

[mml retrieve defaults]

Documentation: Retrieve Defaults

[ Home | Docs | FAQ | Download | CVS | Mailing Lists | Bug Tracker | USPS's MOL Site ]

Syntax

mml retrieve defaults ?attributes?

Positional Arguments

?Arguments | argument ...? (Optional)

The list of attributes(s) to return the default values of.

Return Value

If a specific list of attribute(s) is not specified then all attributes will be returned as a list of key/value pairs, suitable for use with the Tcl [array set] command.

If one attribute is specified it's value is returned.

If multiple attributes are specified their values are returned as a Tcl list in the same order they were given. Multiple attributes can either be given as separate arguments or as a list of arguments. That is, either as [mml document details $document_id foo bar baz] or as [mml document details $document_id details $attributes] where $attributes is a Tcl list containing {foo bar baz}.

An error will be returned if the default value of a non-existant attribute is requested.

Notes

For a list of specific attributes, see configure defaults.