SdsFreeId - Free an identifier, so that its associated memory may be reused.

Function

Free an identifier, so that its associated memory may be reused.

Description

Each identifier allocated by SDS uses memory. To avoid excessive allocation of memory the SdsFreeId function can be used to free the memory associated with an identifer that is no longer needed. When this is done the memory will be reused by SDS for a subsequent identifier when needed.

Language

C

Declaration

void SdsFreeId(SdsIdType id, StatusType * SDSCONST status)

Parameters

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

>idSdsIdTypeIdentifier to be freed
!statusStatusType*Modified status. Possible failure codes are:

SDS__BADID The identifier is invalid.

Support

Jeremy Bailey, {AAO}

Version date

23-Jan-92

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

 For more information, contact tony.farrell@mq.edu.au