GetLabel / SetLabel / RNtfLabel
GetLabel
OCA objects can be labeled to facilitate recognition. The GetLabel method is used to query this property of the OCA object. If the query was successful, the result is output in the property stLabel.
Cyclic method call Since several PLC cycles may pass between sending and the response from the device, this method should be executed cyclically. |
Syntax
VAR_INPUT
pLink : POINTER TO ST_Link;
bExecute : BOOL;
END_VAR
Inputs
Name | Type | Description |
---|---|---|
pLink | POINTER TO ST_Link | Pointer for establishing a connection between OCA objects and the OCA device |
bExecute | BOOL | The method is executed with a positive edge at the bExecute input. |
SetLabel
The SetLabel method can be used to set the labeling of an OCA object. If the method was executed successfully, the result is output in the property stLabel.
Cyclic method call Since several PLC cycles may pass between sending and the response from the device, this method should be executed cyclically. |
Syntax
VAR_INPUT
pLink : POINTER TO ST_Link;
bExecute : BOOL;
sLabel : STRING;
eCmdMode : E_OcaMessageTypeCmd;
END_VAR
Inputs
Name | Type | Description |
---|---|---|
pLink | POINTER TO ST_Link | Pointer for establishing a connection between OCA objects and the OCA device |
bExecute | BOOL | The method is executed with a positive edge at the bExecute input. |
sLabel | STRING | Label for the OCA object |
eCmdMode | E_ OcaMessageTypeCmd | Depending on whether confirmation is required or not, this input variable is set to |
RNtfLabel
If the OCA object is prompted to notify changes (using the Subscription method), incoming notifications are read using the RNtfLabel method.
Cyclic method call Since several PLC cycles may pass between sending and the response from the device, this method should be executed cyclically. |
Syntax
VAR_INPUT
pLink : POINTER TO ST_Link;
bEnable : BOOL;
nSubscribtionNo : UDINT;
END_VAR
Inputs
Name | Type | Description |
---|---|---|
pLink | POINTER TO ST_Link | Pointer for establishing a connection between OCA objects and the OCA device. |
bExecute | BOOL | The method is executed with a positive edge at the bExecute input. |
nSubscribtionNo | UDINT | Unique number for localizing the respective subscription. |