GetCtrlInfo

This function block returns a String containing the value of the control parameter requested.

Arguments

Input

Execute	Description	Rising edge of enable initiates read of parameter
	Data Type	BOOL
	Range	0, 1
	Unit	n/a
	Default	—
Parameter Number	Description	Parameter number to read
	Data Type	INT
	Range	[1,6]
	Unit	n/a
	Value Description	These parameters are also Internal Defines, as shown in the table below. Value Integer Representation Description CTRLINFO_SERIAL_NUMBER 1 Controller serial number CTRLINFO_MODEL_NUMBER 2 Controller model number CTRLINFO_PART_NUMBER 3 Controller part number CTRLINFO_CPU_CORE_COUNT 4 Number of CPU cores in the controller CTRLINFO_PROJECT_BUILD_NO 5 The project build number of the running application CTRLINFO_PROJECT_COMPILE_TIME 6 The project compile time of the running application

Output

Done	Description	Indication that read completed without error
	Data Type	BOOL
Error	Description	Indication that read completed with error
	Data Type	BOOL
ErrorID	Description	Error value to indicate error condition
	Data Type	INT These parameters are also Internal Defines, as shown in the table below. Value Integer Representation Description CTRLINFO_ERROR_NO_ERROR 0 No error CTRLINFO_ERROR_INV_PARAMETER 1 Invalid parameter CTRLINFO_ERROR_CANT_READ_DATA 2 Error reading data CTRLINFO_ERROR_NOT_PDMM 3 Not valid on a non-AKD PDMM controller
Value	Description	String containing data that was read.
	Data Type	STRING

Examples

Structured Text

Inst_GetCtrlInfo( ExecuteRead, CTRLINFO_SERIAL_NUMBER);

if Inst_GetCtrlInfo.Done then
   serialNumber := Inst_GetCtrlInfo.Value;
end_if;

Ladder Diagram

 [Top]