ArgGeti - Get an integer item from an argument structure

Function

Get an integer item from an argument structure

Description

A long integer integer item is read from a named component within the specified argument structure. The item is converted to long integer type if necessary.

Language

C

Declaration

void ArgGeti(SdsIdType id, const char *name, long *value, const StatusType * status)

Parameters

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

>idSdsIdTypeIdentifier to the structure.
>namechar*Name of the component to be read from.
<valuelong*Long variable to read into.
!statusStatusType*Modified status. Possible failure codes are:

SDS__NOMEM Insufficient memory for creation
SDS__BADID Invalid Identifier
ARG__NOTSCALAR Item is not a scalar
ARG__CNVERR Type conversion error

Support

Jeremy Bailey, {AAO}

Version date

27-Mar-92

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

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