ControlCancelReq

This method activates the Cancel service.

METHOD ControlCancelReq : BOOL
VAR_INPUT
    ipCtrl    : I_AcsiCommonControllableDataClass;
    ctlVal    : U_AcsiCtlVal;
    operTm    : T_UtcTime;
    origin    : ST_AcsiOriginator;
    ctlNum    : USINT;
    bTest     : BOOL;
    hUser     : PVOID;
    ipSink    : I_ScsmControlCnfEventSink;
END_VAR
VAR_OUTPUT
    nInvokeID : UDINT;
    ipResult  : I_AsyncServiceResultClass;
END_VAR

ipCtrl: Interface pointer of type I_AcsiCommonControllableDataClass of a controllable object. Objects that implement this interface can be used to run switch control services such as Operate, Select, SelectWithValue or Cancel. Such objects include instances of Controllable Double Point (DPC) or Controllable Single Point (SPC).

ctlVal: Parameter for the new control value of type U_AcsiCtlVal.

operTm: Parameter for the switching time (operating time) of type T_UtcTime for time-controlled command execution. Set this parameter to the value: operTm := AcsiConstants.NULL_TimeStamp if the controllable object does not support the service: TimeActivatedOperate.

origin: Parameter for the command origin of type ST_AcsiOriginator, through with a client issuing the command can be identified.

ctlNum: Identifier (e.g. sequential number) for the command, via which the client can assign the received negative or positive command confirmations to the request.

bTest: Test flag.

hUser: Optional user-defined parameter or pointer. Any value for this parameter can be transferred in the methods for service activation (XyzMethodReq). The value is then mirrored in the event handling routine for the service feedback.

ipSink: Interface pointer of type I_ScsmControlCnfEventSink from an object with a user-defined implementation of the event handling routine: OnControlCnf (service feedback). This parameter is optional and reserved for future use. The pointer value 0 defines the parameter as optional.

ipResult: Interface pointer of type: I_AsyncServiceResultClass This pointer can be used to query and monitor the status/progress and the result of the service execution.

nInvokeID: Identifies the service activation. Each new service activation (XyzMethodReq) is numbered consecutively. A copy of this number is mirrored in the service feedback (OnXyzMethodCnf).

Return parameter: Positive feedback (TRUE) if the service primitive was sent/started successfully, negative feedback (FALSE) on error.