SysTarget Library Documentation ¶ Company System Title SysTarget Version 3.5.17.0 Categories System|SysLibs Author 3S - Smart Software Solutions GmbH Placeholder SysTarget Description 1 ¶ Library, to get access to the target identification Contents: ¶ DeviceTypes (GVL) OperatingSystemID (GVL) ProcessorID (GVL) SysTargetGetDeviceName (Function) SysTargetGetId (Function) SysTargetGetNodeName (Function) SysTargetGetOperatingSystemId (Function) SysTargetGetProcessorId (Function) SysTargetGetSerialNumber (Function) SysTargetGetType (Function) SysTargetGetVendorName (Function) SysTargetGetVersion (Function) Indices and tables ¶ 1 Based on SysTarget.library, last modified 20.04.2021, 16:11:11. LibDoc 4.4.0.0-b.27 The content file SysTarget.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 20.04.2021, 16:11:11.

OperatingSystemID (GVL) ¶ <category>Operating System ID</category> <description>Specifies which operating system is used. With these defines, operating system specific code can be managed.</description> InOut: Scope Name Type Initial Comment Constant SYSTARGET_OS_NONE UDINT 1 <element name=”SYSTARGET_OS_NONE” type=”IN”>No operating system used</element> SYSTARGET_OS_WINDOWS UDINT 2 <element name=”SYSTARGET_OS_WINDOWS” type=”IN”>Windows operating system (user mode)</element> SYSTARGET_OS_WINDOWS_KERNEL UDINT 3 <element name=”SYSTARGET_OS_WINDOWS_KERNEL” type=”IN”>Windows operating system (old name for RTE)</element> SYSTARGET_OS_WINDOWS_RTE UDINT 3 <element name=”SYSTARGET_OS_WINDOWS_KERNEL” type=”IN”>Windows operating system with RTE</element> SYSTARGET_OS_WINDOWS_CE UDINT 4 <element name=”SYSTARGET_OS_WINDOWS_CE” type=”IN”>WindowsCE operating system</element> SYSTARGET_OS_LINUX UDINT 5 <element name=”SYSTARGET_OS_LINUX” type=”IN”>Linux operating system</element> SYSTARGET_OS_VXWORKS UDINT 6 <element name=”SYSTARGET_OS_VXWORKS” type=”IN”>VxWorks operating system</element> SYSTARGET_OS_QNX UDINT 7 <element name=”SYSTARGET_OS_QNX” type=”IN”>QNX operating system</element> SYSTARGET_OS_UCOS UDINT 8 <element name=”SYSTARGET_OS_UCOS” type=”IN”>UCOS operating system</element>

DeviceTypes (GVL) ¶ <category>Device Types</category> InOut: Scope Name Type Initial Comment Constant SYSTARGET_TYPE_SPECIAL_UNREGISTERED_SLOT DWORD 16#0 <element name=”SYSTARGET_TYPE_SPECIAL_UNREGISTERED_SLOT”>Special device with unregistered slots</element> SYSTARGET_TYPE_PROGRAMMABLE DWORD 16#1000 <element name=”SYSTARGET_TYPE_PROGRAMMABLE”>Programmable device</element> SYSTARGET_TYPE_3S_SPECIAL_DEVICE DWORD 16#1001 <element name=”SYSTARGET_TYPE_3S_SPECIAL_DEVICE”>3S special device (e.g. OfflineVisuClient)</element> SYSTARGET_TYPE_SAFETY_DEVICE DWORD 16#1002 <element name=”SYSTARGET_TYPE_SAFETY_DEVICE”>Safety device</element> SYSTARGET_TYPE_DRIVE DWORD 16#1003 <element name=”SYSTARGET_TYPE_DRIVE”>Drive device</element> SYSTARGET_TYPE_PARAMETRIZABLE DWORD 16#1004 <element name=”SYSTARGET_TYPE_PARAMETRIZABLE”>Parametrizable device</element> SYSTARGET_TYPE_HMI DWORD 16#1005 <element name=”SYSTARGET_TYPE_HMI”>Pure HMI device</element> SYSTARGET_TYPE_3S_SOFTMOTION DWORD 16#1006 <element name=”SYSTARGET_TYPE_3S_SOFTMOTION”>3S SoftMotion device</element> SYSTARGET_TYPE_COMMUNICATION DWORD 16#1007 <element name=”SYSTARGET_TYPE_COMMUNICATION”>Communication device (e.g. CoDeSys Gateway”)</element>

SysTargetGetDeviceName (FUN) ¶ FUNCTION SysTargetGetDeviceName : RTS_IEC_RESULT <description>Returns the device name of the target.</description> <result><p>RESULT: Returns the runtime system error code (see CmpErrors.library).</p></result> InOut: Scope Name Type Comment Return SysTargetGetDeviceName RTS_IEC_RESULT Input pwszName POINTER TO WSTRING <param name=”pwszName” type=”OUT”>Pointer to the device name</param> pnMaxLength POINTER TO UDINT <param name=”nMaxLength” type=”IN”>Max length of the name</param>

ProcessorID (GVL) ¶ <category>Processor ID</category> <description>Specifies which processor is used. With these defines, processor specific code can be managed.</description> InOut: Scope Name Type Initial Comment Constant TRG_X86 UDINT 1 <element name=”TRG_X86” type=”IN”>80x86 processor used</element> TRG_ARM UDINT 2 <element name=”TRG_ARM” type=”IN”>ARM processor used</element> TRG_PPC UDINT 3 <element name=”TRG_PPC” type=”IN”>PowerPC processor used</element> TRG_MIPS UDINT 4 <element name=”TRG_MIPS” type=”IN”>MIPS processor used</element> TRG_SH UDINT 5 <element name=”TRG_SH” type=”IN”>Hitachi SH processor used</element> TRG_BLACKFIN UDINT 6 <element name=”TRG_BLACKFIN” type=”IN”>BlackFin processor used</element> TRG_TRICORE UDINT 7 <element name=”TRG_TRICORE” type=”IN”>Infineon TriCore processor used</element> TRG_NIOS UDINT 8 <element name=”TRG_NIOS” type=”IN”>Altera NIOS processor used</element> TRG_C16X UDINT 9 <element name=”TRG_C16X” type=”IN”>Infineon C16x processor used</element> TRG_CORTEX UDINT 10 <element name=”TRG_CORTEX” type=”IN”>Historical name for Cortex M3 CPUs, which are supporting just Thumb2</element> TRG_DSP UDINT 11 <element name=”TRG_DSP” type=”IN”>Historical name for C28x DSPs from TI</element> TRG_V850 UDINT 12 <element name=”TRG_V850” type=”IN”>Renesas V850 processor</element> TRG_RX6 UDINT 13 <element name=”TRG_RX6” type=”IN”>Renesas RX6 processor</element>

SysTargetGetId (FUN) ¶ FUNCTION SysTargetGetId : RTS_IEC_RESULT <description>Returns the TargetId. NOTE: Highword of the TargetId is the VendorId! The VendorId is managed by 3S. </description> <result><p>RESULT: Returns the runtime system error code (see CmpErrors.library).</p></result> InOut: Scope Name Type Comment Return SysTargetGetId RTS_IEC_RESULT Input pulTargetId POINTER TO DWORD <param name=”pulTargetId” type=”OUT”>Pointer to the TargetId</param>

SysTargetGetNodeName (FUN) ¶ FUNCTION SysTargetGetNodeName : RTS_IEC_RESULT <description> Get a human readable name that identifies this node in the network. NOTE: This could be the registered host name of the target in the network. </description> <result><p>RESULT: Returns the runtime system error code (see CmpErrors.library).</p></result> InOut: Scope Name Type Comment Return SysTargetGetNodeName RTS_IEC_RESULT Input pwszName POINTER TO WSTRING <param name=”pwszName” type=”IN”>Buffer that is filled with the name of the node. Type is 2 byte unicode!</param> pnMaxLength POINTER TO UDINT <param name=”nMaxLength” type=”IN”>Maximum length of the node name including the trailing zero</param>

SysTargetGetOperatingSystemId (FUN) ¶ FUNCTION SysTargetGetOperatingSystemId : RTS_IEC_RESULT <description>Returns the ID of the operating system.</description> <result><p>RESULT: Returns the runtime system error code (see CmpErrors.library).</p></result> InOut: Scope Name Type Comment Return SysTargetGetOperatingSystemId RTS_IEC_RESULT Input pudiOperatingSystemId POINTER TO UDINT <param name=”pudiOperatingSystemID” type=”OUT”>Pointer to operating system Id. See category “OperatingSystemID”</param>

SysTargetGetProcessorId (FUN) ¶ FUNCTION SysTargetGetProcessorId : RTS_IEC_RESULT <description>Returns the ID of the processor</description> <result><p>RESULT: Returns the runtime system error code (see CmpErrors.library).</p></result> InOut: Scope Name Type Comment Return SysTargetGetProcessorId RTS_IEC_RESULT Input pudiProcessorId POINTER TO UDINT <param name=”pudiProcessorId” type=”OUT”>Pointer to processor ID. See category “ProcessorID” above</param>

SysTargetGetType (FUN) ¶ FUNCTION SysTargetGetType : RTS_IEC_RESULT <description>Returns the target type. See “Device Types” for details.</description> <result><p>RESULT: Returns the runtime system error code (see CmpErrors.library).</p></result> InOut: Scope Name Type Comment Return SysTargetGetType RTS_IEC_RESULT Input pulType POINTER TO DWORD <param name=”pulType” type=”OUT”>Pointer to target type. See corresponding category “Device Types”</param>