- ←Prev
- ARY
A Subroutine Library for Accessing
ARRAY Data Structures - Next→
- TOC ↑
aryAnnul
Annul an array pointer
Description:
This function annuls the array pointer supplied
so that it is no longer recognised as a valid pointer 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
void aryAnnul( Ary
ary,
int 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 pointer
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 pointer 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).
Parameters :
ary
Address of the array pointer to be annulled. A
value of NULL is returned in place of the supplied pointer.
status
The global status.
- ←Prev
- ARY
A Subroutine Library for Accessing
ARRAY Data Structures - Next→
- TOC ↑