SdsDelete - Delete an object

Function

Delete an object

Description

Delete an object, freeing any memory associated with it. Subsequent attempts to access the object through any identifier associated with it will return the SDS__BADID status. A structure array element cannot be deleted. An attempt to do so will result in the SDS__ILLDEL status.

Deleting an object does not free the memory associated with the identifier referencing it. This memory can be freed with the SdsFreeId function.

Language

C

Declaration

void SdsDelete(SdsIdType id, long *status)

Parameters

(">" input, "!" modified, "W" workspace, "<" output)

>idSdsIdTypeIdentifier of the object to be deleted.
!statusStatusType*Modified status. Possible failure codes are:

SDS__BADID The identifier is invalid.
SDS__EXTERN Object is external.
SDS__ILLDEL Object cannot be deleted.

Support

Jeremy Bailey, {AAO}

Version date

18-Oct-91

Click here for the DRAMA home page and here for the AAO home page.

 For more information, contact tjf@aaoepp.aao.gov.au