7.19.3 CancelPayout Method
The CancelPayout Method cancels the current payout.
If the execution of the Method cannot be done due to some application logic, the Method should return an Uncertain StatusCode and provide details of the failure in the Status output Argument. When the Method returns an Uncertain StatusCode, the Method is considered to be failed.
If the Method returns successful, it indicates, that the current payout has been cancelled and will not continue.
The signature of this Method is specified below. Table 62 and Table 63 specify the Arguments and AddressSpace representation, respectively.
Signature
CancelPayout (
[out] 0:Int32 Status);| Argument | Description |
| Status | Status of the execution of the method. If issues occurred during execution. 0 = Execution was successful. -1 = No payout ongoing that can be cancelled Vendors may return a vendor specific status starting with number -16 or smaller. |
Method Result Codes (defined in Call Service)
| Result Code | Description |
| Bad_UserAccessDenied | See OPC 10000-4 for a general description. |
| Attribute | Value | ||||
| BrowseName | CancelPayout | ||||
| References | NodeClass | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| 0:HasProperty | Variable | 0:OutputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |