DSGetCustInfo

Obtains information reported at the end of execution of certain parallel stages. The information collected, and available to be interrogated, is specified at design time. For example, transformer stage information is specified in the Triggers tab of the Transformer stage Properties dialog box.

Syntax

Result = DSGetCustInfo (JobHandle, StageName, CustInfoName, 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.

CustInfoName is the name of the variable to be interrogated.

InfoType specifies the information required and can be one of:

DSJ.CUSTINFOVALUE

DSJ.CUSTINFODESC

Result depends on the specified InfoType, as follows:

• DSJ.CUSTINFOVALUE String - the value of the specified custinfo item.
• DSJ.CUSTINFODESC String - description of the specified custinfo item.

Result might also return an error condition as follows:

• DSJE.BADHANDLE JobHandle was invalid.
• DSJE.BADTYPE InfoType was unrecognized.
• DSJE.NOTINSTAGE StageName was DSJ.ME and the caller is not running within a stage.
• DSJE.BADSTAGE StageName does not refer to a known stage in the job.
• DSJE.BADCUSTINFO CustInfoName does not refer to a known custinfo item.