SdsAccess - Return an identifier to an external object

Function

Return an identifier to an external object

Description

Make an external object (one exported by SdsExport) accessible to SDS by returning an identifier to it.

Any SDS operations which do not change the structure of the object may be performed on the external object. These include navigation operations (SdsFind, SdsIndex, SdsCell), data access operations (SdsGet, SdsPut, SdsPointer) and inquiry operations (SdsInfo).

Operations which are not permitted on an external object are those which add or remove components (SdsNew, SdsDelete), or write operations (SdsPut or SdsPointer) to data items which are currently undefined.

Unlike SdsImport, SdsAccess does not make a copy of the object. The object is accessed in place in the original buffer.

Language

C

Declaration

void SdsAccess(void *data, SdsIdType *id, StatusType * SDSCONST status)

Parameters

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

>datavoid*The buffer containing the object to be accessed.
<idlong*Identifier of the external object.
!statusStatusType*Modified status. Possible failure codes are:

SDS__NOTSDS Not a valid SDS object.
SDS__NOMEM Insufficient memory.

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 tony.farrell@mq.edu.au