guiGetTag (Function)

This function retrieves the tag value associated with the provided handle.

The tag value is a user defined value that is passed along with certain menus and controls.

Input:

handle : SYSHANDLE

Handle to get the tag for. This function is currently valid for control and menu handles.

Output:

tag : DINT

The value of the tag.

Returns: INT

Declaration:

FUNCTION guiGetTag : INT;
VAR_INPUT
  handle : SYSHANDLE;
  tag    : ACCESS DINT;
END_VAR;

Example:

INCLUDE rtcu.inc
 
PROGRAM test;
VAR
  rc     : INT;
  tag    : DINT;
  handle : SYSHANDLE;
END_VAR;
 
BEGIN
  ...
  // Get the tag value
  rc := guiGetTag(handle := handle, tag := tag);
  ...
END;
END_PROGRAM;