Home >	Contents >	Index >
Template Tag TOC  |   Alpha TOC  |   Tag Family TOC  |   Purpose TOC  |   Annotated TOC  |   Index

OBJECT.GATHER

Gathers fields into an object.

Syntax

<OBJECT.GATHER NAME="object name"
                     [PREFIX="some prefix"]
                     [FIELDLIST="list of field names"]/>

Parameters

NAME (required)

Name of the object in the object pool.

PREFIX (optional)

Specifies the name of a string to be used as the prefix for variable names, which may exist in the environment. A colon (:) is used as a prefix separator, followed by a field name when the object:gather tag is looking for variables in the environment.

FIELDLIST (optional)

Specifies a comma-separated list of field names that should be gathered. Any field in the list that does not exist in the environment is cleared. If this parameter is not specified, then the object:gather tag looks at all fields in the environment. if they are not found the existing value is maintained.

Description

This tag retrieves name/value pairs from the environment, and sets them into a loaded object. The name/value pairs are grouped together using a prefix and a prefix separator.

errno

The possible values of errno include:

Value	Description
-10004	A required parameter is missing.
-10005	The requested object is not in the object pool (is not loaded into memory).

Example

The following example gathers the name and description fields from the environment into object1, using the prefix sample:

<OBJECT.GATHER NAME="object1"
               PREFIX="sample"
               FIELDLIST="name,description"/>

See Also

OBJECT.GET
OBJECT.SCATTER
OBJECT.STREAM

		Home >	Contents >	Index >
	FatWire XML Tag Reference Copyright 2005 by FatWire Software All rights reserved.