getOutputParameter

Back to index

Summary

Gets output parameter from an output parameter container. Uses the parameter name with jobId, jobStepId, or flowRuntimeId object locators to find the parameter. Returns NoSuchOutputParameter error if no output parameter was found.
outputParameterName
Stringrequired
The name of the output parameter.
flowRuntimeId
UUIDoptional
The primary key or name of the flowRuntime container of the property sheet that owns the property.
jobId
UUIDoptional
The ID of the job.
jobStepId
UUIDoptional
The primary key of the job-step container of the property sheet that owns the property.

Usage

Perl

$cmdr->getOutputParameter( "test-outputParameterName" # outputParameterName # optionals );

ectool

ectool getOutputParameter \ "test-outputParameterName" `# outputParameterName` \ # optionals

Examples

Perl

$cmdr->getOutputParameter("Extra Parameter"});

ectool

ectool getOutputParameter "Extra Parameter"