next up previous
Next: ARY_DIM - Enquire the dimension sizes of an array
Up: Routine Descriptions
Previous: ARY_COPY - Copy an array to a new location

ARY_DELET  -  Delete an array

Description:
The routine deletes the specified array. If this is a base array, then the associated data object is erased and all array identifiers which refer to it (or to sections derived from it) become invalid. If the array is mapped for access, then it is first unmapped. If an array section is specified, then this routine is equivalent to calling ARY_ANNUL.

Invocation:
CALL ARY_DELET( IARY, STATUS )

Arguments:
IARY = INTEGER (Given and Returned)
Identifier for the array to be deleted. A value of ARY__NOID is returned.
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.

  • A value of ARY__NOID is always returned for the IARY argument, even if the routine should fail. This constant is defined in the include file ARY_PAR.



next up previous
Next: ARY_DIM - Enquire the dimension sizes of an array
Up: Routine Descriptions
Previous: ARY_COPY - Copy an array to a new location



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