next up previous
Next: ARY_BAD - Determine if an array may contain bad pixels
Up: Routine Descriptions
Previous: Routine Descriptions

ARY_ANNUL  -  Annul an array identifier

Description:
The routine annuls the array identifier supplied so that it is no longer recognised as a valid identifier by the ARY_ routines. Any resources associated with it are released and made available for re-use. If the array is mapped for access, then it is automatically unmapped by this routine.

Invocation:
CALL ARY_ANNUL( IARY, STATUS )

Arguments:
IARY = INTEGER (Given and Returned)
The array identifier to be annulled. A value of ARY__NOID is returned (as defined in the include file ARY_PAR).
STATUS = INTEGER (Given and Returned)
The global status.

Notes:
  • This routine attempts to execute even if STATUS is set on entry, although no further error report will be made if it subsequently fails under these circumstances. In particular, it will fail if the identifier supplied is not initially valid, but this will only be reported if STATUS is set to SAI__OK on entry.

  • An error will result if an attempt is made to annul the last remaining identifier associated with an array which is in an undefined state (unless it is a temporary array, in which case it will be deleted at this point).



next up previous
Next: ARY_BAD - Determine if an array may contain bad pixels
Up: Routine Descriptions
Previous: Routine Descriptions



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