UnitOperationWrapperparameters Property

Gets the component's collection of parameters.

Definition

Namespace: CapeOpen
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
[DispIdAttribute(1)]
public Object parameters { get; }

Property Value

Object
The parameter collection for the unit operation.

Implements

ICapeUtilitiesparameters

Remarks

Returns an ICapeCollection interface. This interface will contain a collection of ICapeParameter interfaces. This method allows any client to access all the CO Parameters exposed by a PMC. Initially, this method was only present in the ICapeUnit interface. Since ICapeUtilities.GetParameters is now available for any kind of PMC, ICapeUnit.GetParameters is deprecated. Consult the “Open Interface Specification: Parameter Common Interface” document for more information about parameter. Consult the “Open Interface Specification: Collection Common Interface” document for more information about collection.

If the PMC does not support exposing its parameters, it should raise the ECapeNoImpl error, instead of returning a NULL reference or an empty Collection. But if the PMC supports parameters but has for this call no parameters, it should return a valid ICapeCollection reference exposing zero parameters.

Exceptions

ECapeUnknownThe error to be raised when other error(s), specified for this operation, are not suitable.
ECapeFailedInitialisationECapeFailedInitialisation
ECapeNoImplECapeNoImpl

See Also