next up previous
Next: ARY_RESET - Reset an array to an undefined state
Up: Routine Descriptions
Previous: ARY_OFFS - Obtain the pixel offset between two arrays

ARY_PLACE  -  Obtain an array placeholder

Description:
The routine returns an array placeholder. A placeholder is used to identify a position in the underlying data system (HDS) and may be passed to other routines (e.g. ARY_NEW) to indicate where a newly created array should be positioned.

Invocation:
CALL ARY_PLACE( LOC, NAME, PLACE, STATUS )

Arguments:
LOC = CHARACTER ( ) (Given)
HDS locator to the structure to contain the new array.
NAME = CHARACTER ( ) (Given)
Name of the new structure component (i.e. the array).
PLACE = INTEGER (Returned)
Array placeholder identifying the nominated position in the data system.
STATUS = INTEGER (Given and Returned)
The global status.

Notes:
  • Placeholders are intended only for local use within an application and only a limited number of them are available simultaneously. They are always annulled as soon as they are passed to another routine to create a new array, where they are effectively exchanged for an array identifier.

  • If this routine is called with STATUS set, then a value of ARY__NOPL will be returned for the PLACE argument, although no further processing will occur. The same value will also be returned if the routine should fail for any reason. The ARY__NOPL constant is defined in the include file ARY_PAR.



next up previous
Next: ARY_RESET - Reset an array to an undefined state
Up: Routine Descriptions
Previous: ARY_OFFS - Obtain the pixel offset between two arrays



ARY A Subroutine Library for Accessing ARRAY Data Structures
Starlink User Note 11
R.F. Warren-Smith
28th April 1998
E-mail:rfws@star.rl.ac.uk