next up previous 210
Next: ARD_GRPEX - Store an ARD description in a GRP group
Up: Routine Descriptions
Previous: Routine Descriptions


ARD_GROUP - Obtain an ARD description from the environment

Description:
An ARD description is obtained from the environment using the supplied parameter name and stored in a group identified by the returned value of IGRP2. If the last character in the ARD description is a minus sign ("-") then the parameter value is then cancelled and further ARD descriptions are obtained and appended to the returned group. This process continues until an ARD description is supplied which does not end with a minus sign, or a null value is supplied.

If a GRP identifier for an existing group is supplied for IGRP1 then the group will be used as the basis for any modification elements contained within the ARD descriptions obtained from the environment. No checks are made for modification elements if the symbolic constant GRP__NOID is supplied for IGRP1.

Invocation:
CALL ARD_GROUP( PARAM, IGRP1, IGRP2, STATUS )
Arguments:
PARAM = CHARACTER $*$ ( $*$ ) (Given)
The parameter name.
IGRP1 = INTEGER (Given)
GRP identifier for a group to be used as a basis for modification elements.
IGRP2 = INTEGER (Returned)
GRP identifier for the created group.
STATUS = INTEGER (Given and Returned)
The global status.
Notes:
  • No checks are made on the syntax of the ARD description.

  • The returned GRP identifier (IGRP2) should be deleted using GRP_DELET when it is no longer needed.

  • If an error occurs either before or during this routine then IGRP2 will be returned holding the symbolic value GRP__NOID (defined in include file GRP_PAR).

  • An error is returned if the first value obtained for the parameter is a null value.


next up previous 210
Next: ARD_GRPEX - Store an ARD description in a GRP group
Up: Routine Descriptions
Previous: Routine Descriptions

ARD A Textual Language for Describing Regions within a Data Array
Starlink User Note 183
D.S. Berry
2nd October 2007
E-mail:starlink@jiscmail.ac.uk

Copyright © 2013 Science and Technology Facilities Council