*loadcols()

Starts a load collector block.

Syntax

*loadcols (card_image_name, ?idpool_name?)

Type

HyperMesh Template Command

Description

Starts a load collector block. Load collectors with a card image matching the specified card image name are considered for the block.

This command must be accompanied by an *output() command at the end of the block.

Inputs

card_image_name
A 32-character string enclosed in double quotes that defines the card image name of the load collector. If specified as double quotes "", all load collectors are considered for the block.
idpool_name
An optional 32-character string enclosed in double quotes that defines the name of the ID pool that the load collectors belongs to. If not needed, use double quotes "" or omit the argument.
The ID pool must be defined using the *defineidpool() command.

Example

To write out all load collectors with the format:

*loadcollector(id,"name",color)


*loadcols("","")
*format()
*string("*loadcollector(")
*field(integer,id,0)
*string(",")
*field(quotedstring,name,0)
*string(",")
*field(integer,color,0)
*string(")")
   *end()
*output()