FB_GetLabel: Gets the Label of Memory Medium

Function Block Description

This function block retrieves the label of a memory medium. If a device has no label, then an empty string is returned.

Library and Namespace

Library name: PLCSystemBase

Namespace: PLCSystemBase

Graphical Representation

IL and ST Representation

To see the general representation in IL or ST language, refer to the chapter Function and Function Block Representation.

I/O Variable Description

This table describes the input variables:

Input

Data type

Description

i_xEnable

BOOL

Activation entry, executes the operation when the value is TRUE.

i_sVolumeName

STRING[80]

Name of the device whose free memory space must be accessed:
  • System disk: '/sys'

  • User disk: '/usr'

  • SD Card: '/sd0'

This table describes the output variables:

Output

Data type

Description

q_xDone

BOOL

Set to TRUE when function block ended.

q_xBusy

BOOL

Set to TRUE when function block has been started and is still executing.

q_OperationResult

DINT

Result of the operation, a non zero value indicates an error.

q_sLabel

STRING[11]

Label of the device.