F_GetCpuCoreInfo
The function F_GetCpuCoreInfo returns information about the CPU core whose index is passed to the function. The information that is read out includes the base time and the core limit for the specified CPU core.
The CPU core index to be passed can be determined with the function F_GetCpuCoreIndex.
The CPU core index corresponds to the value of the Core column that is displayed in the Real-time sub-node below the SYSTEM node. The information that can be read via the CPU core via the function F_GetCpuCoreInfo is also displayed in this view.
The function returns an error code as HRESULT (see also ADS Return Codes). It indicates whether the function call was successful. If an invalid CPU core index is passed, the function returns an error (0x9811070B = invalid parameter values).
FUNCTION F_GetCpuCoreInfo: HRESULT
Inputs
VAR_INPUT
nCpuCoreIndex : DINT;
pInfo : POINTER TO ST_CpuCoreInfo;
END_VAR
Name | Type | Description |
---|---|---|
nCpuCoreIndex | DINT | Index of the CPU core whose information is to be read. |
pInfo | POINTER TO ST_CpuCoreInfo | Address of the variable that is to receive the read data. The address must point to an instance of type ST_CpuCoreInfo. |
Development environment | Target platform | PLC libraries to include |
---|---|---|
TwinCAT v3.1.4024.11 | PC or CX (x86, x64, ARM) | Tc2_System (System) >= 3.4.24.0 |