ArgToString - Take an Sds structure and write it to a string.

Function

Take an Sds structure and write it to a string.

Description

The structure is examined recursively. It scalar or string item found is written to the output string, with a space separating each item. No structure is maintained to the data - each item is converted to a string and appended to the output string.

The normal use of the function is to convert what is expected to be simple structures into something suitable for output to the user.

Language

C

Call

(Void) = ArgToString (id,maxlen,length,string,status)

Parameters

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

>idSdsIdTypeIdentifier to the structure to be deleted.
>maxlenIntLength of buffer to receive string.
!lengthInt *Set to zero on entry. On exit, will contain the actual length of the string.
<stringChar *Character string buffer to write to.
!statusLong int *Modified status.

Include files

Arg.h

External functions used

External values used

none

Prior requirements

none

Support

Tony Farrell, AAO

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

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