next up previous 264
Next: astDistance - Calculate the distance between two points in a Frame
Up: AST Function Descriptions
Previous: astDelFits - Delete the current FITS card in a FitsChan


astDelete - Delete an Object

Description:
This function deletes an Object, freeing all resources associated with it and rendering any remaining pointers to the Object invalid.

Note that deletion is unconditional, regardless of whether other pointers to the Object are still in use (possibly within other Objects). A safer approach is to defer deletion, until all references to an Object have expired, by using astBegin/astEnd (together with astClone and astAnnul if necessary).

Synopsis:
AstObject $*$astDelete( AstObject $*$this )
Parameters:
this
Pointer to the Object to be deleted.
Class Applicability:
Object
This function applies to all Objects.
Returned Value:
astDelete()
A null Object pointer (AST__NULL) is always returned.
Notes:
  • This function attempts to execute even if the AST error status is set on entry, although no further error report will be made if it subsequently fails under these circumstances.


next up previous 264
Next: astDistance - Calculate the distance between two points in a Frame
Up: AST Function Descriptions
Previous: astDelFits - Delete the current FITS card in a FitsChan

AST A Library for Handling World Coordinate Systems in Astronomy
Starlink User Note 211
R.F. Warren-Smith & D.S. Berry
24th May 2011
E-mail:ussc@star.rl.ac.uk

Copyright (C) 2009 Science \& Technology Facilities Council