SdsInfo - Return information about an object

Function

Return information about an object

Description

Given the identifier to an object, return the name, type code and dimensions of the object.

Language

C

Declaration

void SdsInfo(SdsIdType id, char *name, SdsCodeType *code, long *ndims, unsigned long *dims, StatusType * SDSCONST status)

Parameters

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

>idSdsIdTypeThe identifier to the data object.
<namechar*The name of the data object. A pointer to a character string with space for at least 16 characters should be used.
<codeSdsCodeType*The type code for the object. One of the following values (defined in sds.h):

SDS_STRUCT Structure
SDS_CHAR Character
SDS_BYTE Signed byte
SDS_UBYTE Unsigned byte
SDS_SHORT Signed short integer
SDS_USHORT Unsigned short integer
SDS_INT Signed long integer
SDS_UINT Unsigned long integer
SDS_I64 Signed 64 bit integer
SDS_UI64 Unsigned 64 bit integer
SDS_FLOAT Floating point
SDS_DOUBLE Double precision floating point

<ndimslong*The number of dimensions if the object is a primitive or structure array.
<dimsunsigned long*The dimensions of the data. An array of size at least 7 should be allowed to receive this.
!statusStatusType*Modified status. Possible failure codes are:

SDS__BADID The identifier is invalid

Prior requirements

None.

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