SdsIndex - Find a structure component by position

Function

Find a structure component by position

Description

Given the index number of a component in a structure, return an identifier to the component.

Language

C

Declaration

void SdsIndex(SdsIdType parent_id, long index, SdsIdType *id, StatusType * SDSCONST status)

Parameters

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

>parent_idSdsIdTypeIdentifier of the structure.
>indexlongIndex number of the component to be returned. Items in a structure are numbered in order of creation starting with one.
<idSdsIdType*Identifier to the component.
!statusStatusType*Modified status. Possible failure codes are:

SDS__NOMEM Insufficient memory for creation
SDS__NOTSTRUCT parent_id not a structure
SDS__NOITEM No item with that index number

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