DSGetVarInfo

Provides a method of obtaining information about variables used in transformer stages.

Syntax

Result = DSGetVarInfo (JobHandle, StageName, VarName, InfoType)

JobHandle is the handle for the job as derived from DSAttachJob, or it might be DSJ.ME to refer to the current job.

StageName is the name of the stage to be interrogated. It might also be DSJ.ME to refer to the current stage if necessary.

VarName is the name of the variable to be interrogated.

InfoType specifies the information required and can be one of:

DSJ.VARVALUE

DSJ.VARDESCRIPTION

Result depends on the specified InfoType, as follows:

• DSJ.VARVALUE String - the value of the specified variable.
• DSJ.VARDESCRIPTION String - description of the specified variable.

Result might also return an error condition as follows:

• DSJE.BADHANDLE JobHandle was invalid.
• DSJE.BADTYPE InfoType was not recognized.
• DSJE.NOTINSTAGE StageName was DSJ.ME and the caller is not running within a stage.
• DSJE.BADVAR VarName was not recognized.
• DSJE.BADSTAGE StageName does not refer to a known stage in the job.