SdsExtract - Extract an object from a structure

Function

Extract an object from a structure

Description

Extract an object from a structure. The extracted object becomes a new independent top level object. The object is deleted from the original structure.

The identifier must not be that of a structure array component.

If the identifier is already that of a top level object, then the function does nothing.

Language

Declaration

void SdsExtract(SdsIdType id, StatusType * SDSCONST status)

Parameters

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

>	id	SdsIdType	Identifier of the object to be extracted.
`!`	status	StatusType*	Modified status. Possible failure codes are:

`SDS__BADID`	The identifier is invalid.
`SDS__ILLDEL`	Object cannot be extracted.
`SDS__EXTERN`	The object is external.

Support

Jeremy Bailey, {AAO}

Version date

23-Oct-91

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

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