SdpGet - Return the value of a parameter of a given name.

Function

Return the value of a parameter of a given name.

Description

The routine is intended to be specified to DitsAppParamSys as the getRoutine argument.

It finds the parameter by name within the parameter system specified by id. It creates a new Sds structure into which it makes a copy of the required parameter. The structure has a name of ArgStructure and is suitable for access by the Arg routines.

This routine uses the SdsFindByPath routine to find the item and hence can be used to access subsidary parts of a structure.

Language

Call

(Void) = SdpGet (id, name, parid, delete, status)

Parameters

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

>	id	void `*`	An SdpId as returned by SdpInit.
>	name	Char `*`	The null terminated name of the parameter to return. The following special names are supported

`_ALL_`	This requests that the entire parameter system be returned. In this case, an SdpStructure item is returned.
`_NAMES_`	Requests that a list of names be returned. In this case a structure of type SdpNames is returned. This will contain one item, an array with each of the names in it.

<	parid	SdsIdType `*`	The Sds id of the parameter
<	delete	int `*`	Set true to indicate parid sds item should be deleted when Dits is finished with it.
`!`	status	StatusType `*`	Modified status.

Include files

Sdp.h

External functions used

SdsNew	Sds	Create a new Sds item.
SdsFindByPath	Sds	Find an Sds item.
SdsCopy	Sds	Make a copy of an Sds item.
SdsInsert	Sds	Insert one sds item into another.

External values used

none

Prior requirements

SdpInit must have been called.

Support

Tony Farrell, AAO

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

For more information, contact tjf@aaoepp.aao.gov.au