1 #ifndef __MLPILOGICLIB_H__ 2 #define __MLPILOGICLIB_H__ 484 #define MLPI_LOGIC_MAX_DIMENSION_OF_ARRAY ( 3) 486 #define MLPI_APPLICATION_MAX_LENGTH_OF_POU_NAME ( 81) 487 #define MLPI_APPLICATION_MAX_LENGTH_OF_TASK_NAME (260) 488 #define MLPI_APPLICATION_MAX_LENGTH_OF_INFO (260) 490 #define MLPI_APPLICATION_OP_STATE_NONE (0x00000000) 491 #define MLPI_APPLICATION_OP_STATE_PROGRAM_LOADED (0x00000001) 492 #define MLPI_APPLICATION_OP_STATE_DOWNLOAD (0x00000002) 493 #define MLPI_APPLICATION_OP_STATE_ONLINE_CHANGE (0x00000004) 494 #define MLPI_APPLICATION_OP_STATE_STORE_BOOTPROJECT (0x00000008) 495 #define MLPI_APPLICATION_OP_STATE_FORCE_ACTIVE (0x00000010) 496 #define MLPI_APPLICATION_OP_STATE_EXCEPTION (0x00000020) 497 #define MLPI_APPLICATION_OP_STATE_RUN_AFTER_DOWNLOAD (0x00000040) 498 #define MLPI_APPLICATION_OP_STATE_STORE_BOOTPROJECT_ONLY (0x00000080) 499 #define MLPI_APPLICATION_OP_STATE_EXIT (0x00000100) 500 #define MLPI_APPLICATION_OP_STATE_DELETE (0x00000200) 501 #define MLPI_APPLICATION_OP_STATE_RESET (0x00000400) 502 #define MLPI_APPLICATION_OP_STATE_RETAIN_MISMATCH (0x00000800) 503 #define MLPI_APPLICATION_OP_STATE_BOOTPROJECT_VALID (0x00001000) 504 #define MLPI_APPLICATION_OP_STATE_LOAD_BOOTPROJECT (0x00002000) 505 #define MLPI_APPLICATION_OP_STATE_FLOW_ACTIVE (0x00004000) 506 #define MLPI_APPLICATION_OP_STATE_RUN_IN_FLASH (0x00008000) 648 #if !defined(TARGET_OS_VXWORKS) 677 ULONG averageCycleTime;
734 BOOL8 downloadActive;
735 BOOL8 onlineChangeActive;
736 BOOL8 storeBootprojectActive;
738 BOOL8 forceVariablesActive;
740 BOOL8 initializeActive;
741 BOOL8 storeBootprojectOnlyActive;
746 BOOL8 retainMismatch;
748 BOOL8 bootprojectValid;
749 BOOL8 loadBootprojectActive;
750 BOOL8 flowControlActive;
806 #if !defined(TARGET_OS_VXWORKS) 820 #if defined(TARGET_OS_WINNT) 821 #if defined(MLPI_EXPORTS) 822 #define MLPI_API __declspec(dllexport) 823 #elif defined(MLPI_IMPORTS) 824 #define MLPI_API __declspec(dllimport) 829 #if defined(MLPI_EXPORTS) 830 #define MLPI_API __attribute__ ((visibility("default"))) 831 #elif defined(MLPI_IMPORTS) 1477 #if defined (TARGET_OS_VXWORKS_KERNEL) || (TARGET_OS_WINNT) 3689 #endif // endof: #ifndef __MLPILOGICLIB_H__ long LONG
4 byte signed integer
MLPIRESULT mlpiLogicWriteVariableBySymbolUlong(const MLPIHANDLE connection, const WCHAR16 *symbol, const ULONG data)
This function writes a given 32-bit unsigned value (DWORD, UDINT, TIME, DATE, DATE_AND_TIME, ..., MlpiLogicType) to a variable by symbolic access.
MLPIRESULT mlpiLogicWriteVariableBySymbolString(const MLPIHANDLE connection, const WCHAR16 *symbol, const WCHAR16 *data)
This function writes a given character string value (STRING, MlpiLogicType) to a variable by symbolic...
#define MLPI_APPLICATION_MAX_LENGTH_OF_INFO
Maximum length of info element of application.
MLPIRESULT mlpiLogicWriteMemoryAreaArrayUshort(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, const USHORT *data, const ULONG numElements)
This function writes an array of 16-bit unsigned data values (WORD, UINT, MlpiLogicType) to the memor...
MLPIRESULT mlpiLogicReadVariableBySymbolArrayShort(const MLPIHANDLE connection, const WCHAR16 *symbol, SHORT *data, const ULONG numElements, ULONG *numElementsRet)
This function reads an array of 16-bit signed values (INT, MlpiLogicType) from a variable by symbolic...
1 Byte character strings (use WCHAR16 string)
MLPIRESULT mlpiLogicGetStateOfApplication(const MLPIHANDLE connection, const WCHAR16 *application, MlpiApplicationState *state)
This function will return the state of an application.
MLPIRESULT mlpiLogicGetCapabilityOfOperation(const MLPIHANDLE connection, const MlpiLogicCapabilityOperation operation, MlpiLogicCapabilityOperationValue *value)
This function reads the current execution capability of operations MlpiLogicCapabilityOperation.
MLPIRESULT mlpiLogicWriteVariableBySymbolDouble(const MLPIHANDLE connection, const WCHAR16 *symbol, const DOUBLE data)
This function writes a given 64-bit floating point value (double precision, LREAL, MlpiLogicType) to a variable by symbolic access.
MlpiApplicationEvent
This enumeration defines the event of an application using by mlpiLogicWaitForEventOfApplication.
MLPIRESULT mlpiLogicPouExtensionUnregister(const MLPIHANDLE connection, const WCHAR16 *name, const MLPIPOUFNCPTR function, const ULONG signature=0, const ULONG version=0)
This function unregisters a C/C++ implementation of a POU (e.g. function block) at MLPI real-time env...
MLPIRESULT mlpiLogicReadVariableBySymbolArrayLong(const MLPIHANDLE connection, const WCHAR16 *symbol, LONG *data, const ULONG numElements, ULONG *numElementsRet)
This function reads an array of 32-bit signed values (DINT, MlpiLogicType) from a variable by symboli...
unsigned char UCHAR
1 byte unsigned integer
MLPIRESULT mlpiLogicReadMemoryAreaArrayUshort(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, USHORT *data, const ULONG numElements, ULONG *numElementsRet)
This function reads an array of 16-bit unsigned data values (WORD, UINT, MlpiLogicType) from the memo...
MLPIRESULT mlpiLogicReadMemoryAreaChar(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, CHAR *data)
This function reads the 8-bit signed data value (SINT, MlpiLogicType) from the memory area (MlpiAppli...
MLPIRESULT mlpiLogicReadVariableBySymbolArrayUchar(const MLPIHANDLE connection, const WCHAR16 *symbol, UCHAR *data, const ULONG numElements, ULONG *numElementsRet)
This function reads an array of 8-bit unsigned values (BYTE, USINT, MlpiLogicType) from a variable by...
4 Byte unsigned double integer (ULONG)
MLPIRESULT mlpiLogicReadVariableBySymbolDouble(const MLPIHANDLE connection, const WCHAR16 *symbol, DOUBLE *data)
This function reads a 64-bit floating point value (double precision, LREAL, MlpiLogicType) from a var...
struct MlpiLogicSymbolInformation MlpiLogicSymbolInformation
This structure defines the information about a symbol using mlpiLogicGetInformationOfSymbol.
MLPIRESULT mlpiLogicReadMemoryAreaArrayChar(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, CHAR *data, const ULONG numElements, ULONG *numElementsRet)
This function reads an array of 8-bit signed data values (SINT, MlpiLogicType) from the memory area (...
long MLPIRESULT
common MLPI-API return value
Capability to execute the operation 'download application'.
MLPIRESULT mlpiLogicReadVariableBySymbolUlong(const MLPIHANDLE connection, const WCHAR16 *symbol, ULONG *data)
This function reads a 32-bit unsigned value (DWORD, UDINT, TIME, DATE, DATE_AND_TIME, ..., MlpiLogicType) from a variable by symbolic access.
MLPIRESULT mlpiLogicPouExtensionUnregisterAll(const MLPIHANDLE connection)
This function unregisters all C/C++ implementations of POUs (e.g. function blocks) at MLPI real-time ...
MLPIRESULT mlpiLogicWriteVariableBySymbolUchar(const MLPIHANDLE connection, const WCHAR16 *symbol, const UCHAR data)
This function writes a given 8-bit unsigned value (BYTE, USINT, MlpiLogicType) to a variable by symbo...
2 Byte character strings (WCHAR16)
This event raises on begin of 'download application' sequence.
MLPIRESULT mlpiLogicWriteVariableBySymbolArrayUlong(const MLPIHANDLE connection, const WCHAR16 *symbol, const ULONG *data, const ULONG numElements)
This function writes an array of 32-bit unsigned values (DWORD, UDINT, TIME, DATE, DATE_AND_TIME, ..., MlpiLogicType) to a variable by symbolic access.
MLPIRESULT mlpiLogicGetNumberOfApplications(const MLPIHANDLE connection, ULONG *number)
This function will return the number of applications.
MlpiLogicCapabilityOperationValue
This enumeration defines the possible capability to execute an operation.
This event raises on change of operation state of application ( ref@ MlpiApplicationOpState )...
MLPIRESULT mlpiLogicWriteVariableBySymbolFloat(const MLPIHANDLE connection, const WCHAR16 *symbol, const FLOAT data)
This function writes a given 32-bit floating point value (single precision, REAL, MlpiLogicType) to a...
This event raises on begin of 'exit application' sequence.
unsigned long long ULLONG
8 byte unsigned integer
MLPIRESULT mlpiLogicReadVariableBySymbolFloat(const MLPIHANDLE connection, const WCHAR16 *symbol, FLOAT *data)
This function reads a 32-bit floating point value (single precision, REAL, MlpiLogicType) from a vari...
Array (use element type, base types or VOID in case of complex type)
char CHAR
1 byte signed integer
MlpiLogicSymbolAccessRights
This enumeration defines the access rights to a variable using mlpiLogicGetAccessRightsOfSymbol.
No access rights to the variable.
Capability to execute the operation 'reset application'.
MLPIRESULT mlpiLogicSaveRetainOfApplication(const MLPIHANDLE connection, const WCHAR16 *application, const WCHAR16 *path=0)
This function will save the retain data of an application to default storage or to a user-defined fil...
Symbolic access unsupported.
Enable capability to execute an operation (default).
MLPIRESULT mlpiLogicWaitForEventOfApplication(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationEvent event, const ULONG timeout)
This function pends the calling task until the given event occurs.
#define MLPI_LOGIC_MAX_DIMENSION_OF_ARRAY
Maximum dimension of an array.
MLPIRESULT mlpiLogicWriteVariableBySymbolLlong(const MLPIHANDLE connection, const WCHAR16 *symbol, const LLONG data)
This function writes a given 64-bit signed value (LINT, MlpiLogicType) to a variable by symbolic acce...
signed char BOOL8
1 byte boolean
4 Byte, time is given in milliseconds (ULONG)
unsigned short USHORT
2 byte unsigned integer
MLPIRESULT mlpiLogicReadVariableBySymbolArrayVoid(const MLPIHANDLE connection, const WCHAR16 *symbol, void *data, const ULONG dataSize, ULONG *dataSizeRet)
This function reads user-defined data type values from a variable by symbolic access (raw reading)...
MLPIRESULT mlpiLogicWriteMemoryAreaArrayLong(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, const LONG *data, const ULONG numElements)
This function writes an array of 32-bit signed data values (DINT, MlpiLogicType) to the memory area (...
This event raises on end of 'exit application' sequence.
MLPIRESULT mlpiLogicWriteMemoryAreaArrayDouble(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, const DOUBLE *data, const ULONG numElements)
This function writes an array of 64-bit floating point data values (double precision, LREAL, MlpiLogicType) to the memory area (MlpiApplicationMemoryArea).
unsigned long PROCESSHANDLE
MLPI handle value used for a process.
MLPIRESULT mlpiLogicReadVariableBySymbolLlong(const MLPIHANDLE connection, const WCHAR16 *symbol, LLONG *data)
This function reads a 64-bit signed value (LINT, MlpiLogicType) from a variable by symbolic access...
8 Byte floating point IEC 559 - 8 Byte (DOUBLE)
MLPIRESULT mlpiLogicWriteMemoryAreaLlong(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, const LLONG data)
This function writes the 64-bit signed data value (LINT, MlpiLogicType) to the memory area (MlpiAppli...
4 Byte floating point IEC 559 - 4 Byte (FLOAT)
MLPIRESULT mlpiLogicGetNumElementsOfSymbol(const MLPIHANDLE connection, const WCHAR16 *symbol, ULONG *numElements)
This function reads the number of elements of an array or user type of a symbol variable of PLC appli...
MLPIRESULT mlpiLogicReadMemoryAreaArrayUchar(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, UCHAR *data, const ULONG numElements, ULONG *numElementsRet)
This function reads an array of 8-bit unsigned data values (BYTE, USINT, MlpiLogicType) from the memo...
1 Byte unsigned signed short integer (USHORT)
This event raises on begin of 'start application' sequence.
This event raises on end of 'reset application' sequence.
struct MlpiApplicationOpState MlpiApplicationOpState
This structure defines the operation states of an application using mlpiLogicGetOperationStateOfAppli...
8 Byte signed long integer (LLONG)
MLPIRESULT mlpiLogicWriteMemoryAreaFloat(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, const FLOAT data)
This function writes the 32-bit floating point data value (single precision, REAL, MlpiLogicType) to the memory area (MlpiApplicationMemoryArea).
Symbolic access unsupported.
Reset application back to origin, delete application, delete all application files (boot project...
MlpiApplicationResetMode
This enumeration defines the different reset possibilities of an application using mlpiLogicResetAppl...
MLPIRESULT mlpiLogicReadMemoryAreaArrayLlong(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, LLONG *data, const ULONG numElements, ULONG *numElementsRet)
This function reads an array of 64-bit signed data values (LINT, MlpiLogicType) from the memory area ...
MLPIRESULT mlpiLogicReadVariableBySymbolArrayLlong(const MLPIHANDLE connection, const WCHAR16 *symbol, LLONG *data, const ULONG numElements, ULONG *numElementsRet)
This function reads an array of 64-bit signed values (LINT, MlpiLogicType) from a variable by symboli...
struct MlpiLogicArrayRange MlpiLogicArrayRange
This structure defines the range of an array dimension.
MLPIRESULT mlpiLogicReadMemoryAreaShort(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, SHORT *data)
This function reads the 16-bit signed data value (INT, MlpiLogicType) from the memory area (MlpiAppli...
Symbolic access unsupported.
This event raises on end of 'delete application' sequence.
MLPIRESULT mlpiLogicReadVariableBySymbolUllong(const MLPIHANDLE connection, const WCHAR16 *symbol, ULLONG *data)
This function reads a 64-bit unsigned value (LWORD, ULINT, MlpiLogicType) from a variable by symbolic...
MLPIRESULT mlpiLogicReadVariableBySymbolUshort(const MLPIHANDLE connection, const WCHAR16 *symbol, USHORT *data)
This function reads a 16-bit unsigned value (WORD, UINT, MlpiLogicType) from a variable by symbolic a...
Symbolic access unsupported.
Symbolic access unsupported.
MLPIRESULT mlpiLogicWriteVariableBySymbolLong(const MLPIHANDLE connection, const WCHAR16 *symbol, const LONG data)
This function writes a given 32-bit signed value (DINT, MlpiLogicType) to a variable by symbolic acce...
MLPIRESULT mlpiLogicWriteVariableBySymbolShort(const MLPIHANDLE connection, const WCHAR16 *symbol, const SHORT data)
This function writes a given 16-bit signed value (INT, MlpiLogicType) to a variable by symbolic acces...
MLPIRESULT mlpiLogicReadVariableBySymbolUchar(const MLPIHANDLE connection, const WCHAR16 *symbol, UCHAR *data)
This function reads an 8-bit unsigned value (BYTE, USINT, MlpiLogicType) from a variable by symbolic ...
4 Byte, time is given in seconds beginning with January 1, 1970 at 12:00 a.m. (00:00 a...
short SHORT
2 byte signed integer
MlpiLogicCapabilityOperation
This enumeration defines an operation which can be enabled or disabled by mlpiLogicSetCapabilityOfOpe...
The application runs for one single cycle.
MLPIRESULT mlpiLogicGetInformationOfSymbol(const MLPIHANDLE connection, const WCHAR16 *symbol, MlpiLogicSymbolInformation *info)
This function reads the types, size, number of elements, array information and access rights of a sym...
MLPIRESULT mlpiLogicReadMemoryAreaUllong(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, ULLONG *data)
This function reads the 64-bit unsigned data value (LWORD, ULINT, MlpiLogicType) from the memory area...
MLPIRESULT mlpiLogicWriteVariableBySymbolUshort(const MLPIHANDLE connection, const WCHAR16 *symbol, const USHORT data)
This function writes a given 16-bit unsigned value (WORD, UINT, MlpiLogicType) to a variable by symbo...
MLPIRESULT mlpiLogicPouExtensionRegister(const MLPIHANDLE connection, const WCHAR16 *name, const MLPIPOUFNCPTR function, const ULONG signature=0, const ULONG version=0)
This function registers a C/C++ implementation of a POU (e.g. function block) from the MLPI real-time...
MLPIRESULT mlpiLogicWriteVariableBySymbolArrayVoid(const MLPIHANDLE connection, const WCHAR16 *symbol, const void *data, const ULONG dataSize)
This function writes user-defined data type values to a variable by symbolic access.
MLPIRESULT mlpiLogicReadMemoryAreaArrayFloat(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, FLOAT *data, const ULONG numElements, ULONG *numElementsRet)
This function reads an array of 32-bit floating point data values (single precision, REAL, MlpiLogicType) from the memory area (MlpiApplicationMemoryArea).
MLPIRESULT mlpiLogicWriteMemoryAreaArrayLlong(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, const LLONG *data, const ULONG numElements)
This function writes an array of 64-bit signed data values (LINT, MlpiLogicType) to the memory area (...
MLPIRESULT mlpiLogicReadVariableBySymbolString(const MLPIHANDLE connection, const WCHAR16 *symbol, WCHAR16 *data, const ULONG numElements)
This function reads a character string value (STRING, MlpiLogicType) from a variable by symbolic acce...
MLPIRESULT mlpiLogicWriteVariableBySymbolArrayDouble(const MLPIHANDLE connection, const WCHAR16 *symbol, const DOUBLE *data, const ULONG numElements)
This function writes an array of 64-bit floating point values (double precision, LREAL, MlpiLogicType) to a variable by symbolic access.
MLPIRESULT mlpiLogicReadVariableBySymbolChar(const MLPIHANDLE connection, const WCHAR16 *symbol, CHAR *data)
This function reads an 8 bit signed value (SINT, MlpiLogicType) from a variable by symbolic access...
Write access rights to the variable.
MLPIRESULT mlpiLogicGetOperationStateOfApplicationUlong(const MLPIHANDLE connection, const WCHAR16 *application, ULONG *state)
This function will return the extended operation state of an application by using an unsigned 4 byte ...
2 Byte unsigned signed integer (USHORT)
MLPIRESULT mlpiLogicWriteVariableBySymbolUllong(const MLPIHANDLE connection, const WCHAR16 *symbol, const ULLONG data)
This function writes a given 64-bit unsigned value (LWORD, ULINT, MlpiLogicType) to a variable by sym...
MlpiApplicationState
This enumeration defines the state of an application using mlpiLogicGetStateOfApplication.
MLPIRESULT mlpiLogicReadMemoryAreaDouble(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, DOUBLE *data)
This function reads the 64-bit floating point data value (double precision, LREAL, MlpiLogicType) from the memory area (MlpiApplicationMemoryArea).
wchar_t WCHAR16
UTF16 string.
This event raises on an exception of application.
4 Byte signed double integer (LONG)
MLPIRESULT mlpiLogicWriteVariableBySymbolArrayUllong(const MLPIHANDLE connection, const WCHAR16 *symbol, const ULLONG *data, const ULONG numElements)
This function writes an array of 64-bit unsigned values (LWORD, ULINT, MlpiLogicType) to a variable b...
Read and write access rights to the variable.
MLPIRESULT mlpiLogicGetNameOfApplication(const MLPIHANDLE connection, const ULONG index, WCHAR16 *application, const ULONG numElements)
This function will return the name of an application selected by index 0 until (number-1).
MLPIRESULT mlpiLogicWriteMemoryAreaUllong(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, const ULLONG data)
This function writes the 64-bit unsigned data value (LWORD, ULINT, MlpiLogicType) to the memory area ...
The application is in state RUN.
MLPIRESULT mlpiLogicReadVariableBySymbolArrayDouble(const MLPIHANDLE connection, const WCHAR16 *symbol, DOUBLE *data, const ULONG numElements, ULONG *numElementsRet)
This function reads an array of 64-bit floating point values (double precision, LREAL, MlpiLogicType) from a variable by symbolic access.
MLPIRESULT mlpiLogicGetSizeOfSymbol(const MLPIHANDLE connection, const WCHAR16 *symbol, ULONG *dataSize)
This function reads the size in bytes of a symbol variable of PLC application. This and further infor...
MLPIRESULT mlpiLogicGetTypeOfSymbol(const MLPIHANDLE connection, const WCHAR16 *symbol, MlpiLogicType *type, MlpiLogicType *subtype=0)
This function reads the type and sybtype of a symbol variable of PLC application. This and further in...
MlpiLogicType
This enumeration defines the different symbol types of the logic using mlpiLogicGetTypeOfSymbol.
MLPIRESULT mlpiLogicStartApplication(const MLPIHANDLE connection, const WCHAR16 *application=0)
This function will start an application.
Symbolic access unsupported.
struct MlpiApplicationTaskInfo MlpiApplicationTaskInfo
This structure defines the information about an IEC task using mlpiLogicGetTaskInfoOfApplication.
MLPIRESULT mlpiLogicWriteMemoryAreaArrayUchar(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, const UCHAR *data, const ULONG numElements)
This function writes an array of 8-bit unsigned data values (BYTE, USINT, MlpiLogicType) to the memor...
Symbolic access unsupported (1 Bit)
MLPIRESULT mlpiLogicReadVariableBySymbolArrayChar(const MLPIHANDLE connection, const WCHAR16 *symbol, CHAR *data, const ULONG numElements, ULONG *numElementsRet)
This function reads an array of 8-bit signed values (SINT, MlpiLogicType) from a variable by symbolic...
MLPIRESULT mlpiLogicRestoreRetainOfApplication(const MLPIHANDLE connection, const WCHAR16 *application, const WCHAR16 *path)
This function will restore the retain data of an application from a user-defined file.
MLPIRESULT mlpiLogicWriteVariableBySymbolArrayUshort(const MLPIHANDLE connection, const WCHAR16 *symbol, const USHORT *data, const ULONG numElements)
This function writes an array of 16-bit unsigned values (WORD, UINT, MlpiLogicType) to a variable by ...
struct MlpiLogicUserTypeInformation MlpiLogicUserTypeInformation
This structure defines the information about a type of a symbol using mlpiLogicGetInformationOfUserTy...
This event raises on begin of 'stop application' sequence.
'Ix' input memory area (Input) of an application.
MLPIRESULT mlpiLogicWriteVariableBySymbolArrayUchar(const MLPIHANDLE connection, const WCHAR16 *symbol, const UCHAR *data, const ULONG numElements)
This function writes an array of 8-bit unsigned values (BYTE, USINT, MlpiLogicType) to a variable by ...
'Mx' marker memory area (Marker) of an application.
MLPIRESULT mlpiLogicWriteMemoryAreaLong(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, const LONG data)
This function writes the 32-bit signed data value (DINT, MlpiLogicType) to the memory area (MlpiAppli...
Symbolic access unsupported.
MLPIRESULT mlpiLogicWriteMemoryAreaArrayChar(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, const CHAR *data, const ULONG numElements)
This function writes an array of 8-bit signed data values (SINT, MlpiLogicType) to the memory area (M...
This event raises on end of 'start application' sequence.
MLPIRESULT mlpiLogicGetInformationOfUserType(const MLPIHANDLE connection, const WCHAR16 *symbol, MlpiLogicUserTypeInformation *info, const ULONG numElements, ULONG *numElementsRet=0)
This function reads names and information of variables (MlpiLogicSymbolInformation) of a symbol varia...
MLPIRESULT mlpiLogicReadMemoryAreaLong(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, LONG *data)
This function reads the 32-bit signed data value (DINT, MlpiLogicType) from the memory area (MlpiAppl...
MLPIRESULT mlpiLogicWriteVariableBySymbolArrayLlong(const MLPIHANDLE connection, const WCHAR16 *symbol, const LLONG *data, const ULONG numElements)
This function writes an array of 64-bit signed values (LINT, MlpiLogicType) to a variable by symbolic...
MLPIRESULT mlpiLogicLoadBootApplication(const MLPIHANDLE connection, const WCHAR16 *file, const WCHAR16 *path, WCHAR16 *application, const ULONG numElements)
This function will load an application from the device file system. The application files can be crea...
MLPIRESULT mlpiLogicWriteMemoryAreaArrayFloat(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, const FLOAT *data, const ULONG numElements)
This function writes an array of 32-bit floating point data values (single precision, REAL, MlpiLogicType) to the memory area (MlpiApplicationMemoryArea).
Capability to execute the operation 'set breakpoint into an application'.
MLPIRESULT mlpiLogicReadMemoryAreaFloat(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, FLOAT *data)
This function reads the 32-bit floating point data value (single precision, REAL, MlpiLogicType) from...
MLPIRESULT mlpiLogicGetArrayRangeOfSymbol(const MLPIHANDLE connection, const WCHAR16 *symbol, const ULONG index, MlpiLogicArrayRange *range)
This function reads the minimum index and maximum index resp. the range of an array dimension of a sy...
MLPIRESULT mlpiLogicWriteMemoryAreaUshort(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, const USHORT data)
This function writes the 16-bit unsigned data value (WORD, UINT, MlpiLogicType) to the memory area (M...
MLPIRESULT mlpiLogicWriteMemoryAreaArrayShort(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, const SHORT *data, const ULONG numElements)
This function writes an array of 16-bit signed data values (INT, MlpiLogicType) to the memory area (M...
The application is in state STOP.
'Qx' output memory area (Output) of an application.
MLPIRESULT mlpiLogicReadVariableBySymbolArrayFloat(const MLPIHANDLE connection, const WCHAR16 *symbol, FLOAT *data, const ULONG numElements, ULONG *numElementsRet)
This function reads an array of 32-bit floating point values (single precision, REAL, MlpiLogicType) from a variable by symbolic access.
MLPIRESULT mlpiLogicWriteVariableBySymbolArrayFloat(const MLPIHANDLE connection, const WCHAR16 *symbol, const FLOAT *data, const ULONG numElements)
This function writes an array of 32-bit floating point values (single precision, REAL, MlpiLogicType) to a variable by symbolic access.
Capability to execute the operation 'force variable of application'.
struct MlpiDateAndTime MlpiDateAndTime
This structure defines the broken date and time information.
MLPIRESULT mlpiLogicGetAccessRightsOfSymbol(const MLPIHANDLE connection, const WCHAR16 *symbol, MlpiLogicSymbolAccessRights *accessrights)
This function reads the access rights of a symbol variable of PLC application. This and further infor...
MLPIRESULT mlpiLogicStopApplication(const MLPIHANDLE connection, const WCHAR16 *application=0)
This function will stop an application. All motion that is assigned to the application will stop! ...
This event raises on begin of 'reset application' sequence.
MLPIRESULT mlpiLogicWriteMemoryAreaDouble(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, const DOUBLE data)
This function writes the 64-bit floating point data value (double precision, LREAL, MlpiLogicType) to the memory area (MlpiApplicationMemoryArea).
MLPIRESULT mlpiLogicGetSymbolsOfApplication(const MLPIHANDLE connection, const WCHAR16 *application, PROCESSHANDLE *node, WCHAR16 *symbols, const ULONG numElements)
This function will read all symbols of an application. The symbols themselves are separated from each...
MLPIRESULT mlpiLogicGetOperationStateOfApplication(const MLPIHANDLE connection, const WCHAR16 *application, MlpiApplicationOpState *state)
This function will return the extended operation state of an application by using struct MlpiApplicat...
MLPIRESULT mlpiLogicGetStopAxesConfiguration(const MLPIHANDLE connection, WCHAR16 *configuration, const ULONG numElements, ULONG *numElementsRet)
This function will return the active "StopAxes" and "StopAxesCommon" configuration of all application...
MLPIRESULT mlpiLogicReadMemoryAreaArrayLong(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, LONG *data, const ULONG numElements, ULONG *numElementsRet)
This function reads an array of 32-bit signed data values (DINT, MlpiLogicType) from the memory area ...
MLPIRESULT mlpiLogicResetApplication(const MLPIHANDLE connection, const MlpiApplicationResetMode resetMode, const WCHAR16 *application=0)
This function will reset an application. All motion that is assigned to the application will stop! ...
MLPIRESULT mlpiLogicWriteVariableBySymbolArrayShort(const MLPIHANDLE connection, const WCHAR16 *symbol, const SHORT *data, const ULONG numElements)
This function writes an array of 16-bit signed values (INT, MlpiLogicType) to a variable by symbolic ...
MLPIRESULT mlpiLogicReadMemoryAreaArrayUlong(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, ULONG *data, const ULONG numElements, ULONG *numElementsRet)
This function reads an array of 32-bit unsigned data values (DWORD, UDINT, MlpiLogicType) from the me...
MLPIRESULT mlpiLogicSetCapabilityOfOperation(const MLPIHANDLE connection, const MlpiLogicCapabilityOperation operation, const MlpiLogicCapabilityOperationValue value)
This function enables or disables the execution capability of operations MlpiLogicCapabilityOperation...
MLPIRESULT mlpiLogicWriteVariableBySymbolArrayChar(const MLPIHANDLE connection, const WCHAR16 *symbol, const CHAR *data, const ULONG numElements)
This function writes an array of 8-bit signed values (SINT, MlpiLogicType) to a variable by symbolic ...
2 Byte signed integer (SHORT)
Disable capability to execute an operation.
MLPIRESULT mlpiLogicWriteVariableBySymbolArrayBool8(const MLPIHANDLE connection, const WCHAR16 *symbol, const BOOL8 *data, const ULONG numElements)
This function writes an array of Boolean values (BOOL, MlpiLogicType) to a variable by symbolic acces...
void(* MLPIPOUFNCPTR)(void *)
MLPI POU function pointer 'void function(void*);'.
MLPIRESULT mlpiLogicReadMemoryAreaUshort(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, USHORT *data)
This function reads the 16-bit unsigned data value (WORD, UINT, MlpiLogicType) from the memory area (...
This event raises on begin of 'online change application' sequence.
Symbolic access unsupported.
MLPIRESULT mlpiLogicGetAddressOfSymbol(const MLPIHANDLE connection, const WCHAR16 *symbol, ULONG *address)
This function reads the physical kernel space address of a symbol variable of a PLC application...
4 Byte, time is given in milliseconds, time begins at 12:00 a.m. (00:00 a.m.) (ULONG) ...
MLPIRESULT mlpiLogicGetDimensionOfSymbol(const MLPIHANDLE connection, const WCHAR16 *symbol, ULONG *dimension)
This function reads the array dimension of a symbol variable of PLC application. This and further inf...
MLPIRESULT mlpiLogicReadVariableBySymbolLong(const MLPIHANDLE connection, const WCHAR16 *symbol, LONG *data)
This function reads a 32-bit signed value (DINT, MlpiLogicType) from a variable by symbolic access...
MLPIRESULT mlpiLogicReadVariableBySymbolArrayUshort(const MLPIHANDLE connection, const WCHAR16 *symbol, USHORT *data, const ULONG numElements, ULONG *numElementsRet)
This function reads an array of 16-bit unsigned values (WORD, UINT, MlpiLogicType) from a variable by...
MLPIRESULT mlpiLogicReadMemoryAreaUlong(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, ULONG *data)
This function reads the 32-bit unsigned data value (DWORD, UDINT, MlpiLogicType) from the memory area...
Symbolic access unsupported.
MLPIRESULT mlpiLogicWriteMemoryAreaUlong(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, const ULONG data)
This function writes the 32-bit unsigned data value (DWORD, UDINT, MlpiLogicType) to the memory area ...
MLPIRESULT mlpiLogicWriteMemoryAreaBool8(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG bitOffset, const BOOL8 data)
This function writes a Boolean value e.g. a bit (BOOL8, MlpiLogicType) to the memory area (MlpiApplic...
Read access rights to the variable.
MLPIRESULT mlpiLogicWriteMemoryAreaUchar(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, const UCHAR data)
This function writes the 8-bit unsigned data value (BYTE, USINT, MlpiLogicType) to the memory area (M...
4 Byte, time is given in seconds beginning with January 1, 1970 at 12:00 a.m. (00:00 a...
MLPIRESULT mlpiLogicReadMemoryAreaArrayUllong(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, ULLONG *data, const ULONG numElements, ULONG *numElementsRet)
This function reads an array of 64-bit unsigned data values (LWORD, ULINT, MlpiLogicType) from the me...
#define MLPI_APPLICATION_MAX_LENGTH_OF_POU_NAME
Maximum length of name of a POU.
Symbolic access unsupported.
Reset warm of application, all global data except retain data is reset to default.
This event raises on end of 'stop application' sequence.
Symbolic access unsupported.
unsigned long ULONG
4 byte unsigned integer
8 Byte unsigned long integer (ULLONG)
long long LLONG
8 byte signed integer
Invalid state of application.
MLPIRESULT mlpiLogicReadVariableBySymbolArrayBool8(const MLPIHANDLE connection, const WCHAR16 *symbol, BOOL8 *data, const ULONG numElements, ULONG *numElementsRet)
This function reads an array of Boolean values (BOOL, MlpiLogicType) from a variable by symbolic acce...
MLPIRESULT mlpiLogicWriteVariableBySymbolArrayLong(const MLPIHANDLE connection, const WCHAR16 *symbol, const LONG *data, const ULONG numElements)
This function writes an array of 32-bit signed values (DINT, MlpiLogicType) to a variable by symbolic...
float FLOAT
4 byte floating point
MLPIRESULT mlpiLogicGetInfoOfApplication(const MLPIHANDLE connection, const WCHAR16 *application, MlpiApplicationInfo *info)
This function will return information about the given application.
MLPIRESULT mlpiLogicReadMemoryAreaUchar(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, UCHAR *data)
This function reads the 8-bit unsigned data value (BYTE, USINT, MlpiLogicType) from the memory area (...
MLPIRESULT mlpiLogicReadMemoryAreaLlong(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, LLONG *data)
This function reads the 64-bit signed data value (LINT, MlpiLogicType) from the memory area (MlpiAppl...
MLPIRESULT mlpiLogicReadMemoryAreaBool8(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG bitOffset, BOOL8 *data)
This function reads a bit as a BOOL8 (BOOL8, MlpiLogicType) from the memory area (MlpiApplicationMemo...
MLPIRESULT mlpiLogicWriteMemoryAreaArrayUlong(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, const ULONG *data, const ULONG numElements)
This function writes an array of 32-bit unsigned data values (DWORD, UDINT, MlpiLogicType) to the mem...
double DOUBLE
8 byte floating point
Symbolic access unsupported.
Capability to execute the operation 'online change application'.
MLPIRESULT mlpiLogicReadVariableBySymbolShort(const MLPIHANDLE connection, const WCHAR16 *symbol, SHORT *data)
This function reads a 16-bit signed value (INT, MlpiLogicType) from a variable by symbolic access...
MLPIRESULT mlpiLogicReadVariableBySymbolArrayUlong(const MLPIHANDLE connection, const WCHAR16 *symbol, ULONG *data, const ULONG numElements, ULONG *numElementsRet)
This function reads an array of 32-bit unsigned values (DWORD, UDINT, TIME, DATE, DATE_AND_TIME...
Capability to execute the operation 'write variable of application'.
Symbolic access unsupported.
MLPIRESULT mlpiLogicWriteMemoryAreaArrayUllong(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, const ULLONG *data, const ULONG numElements)
This function writes an array of 64-bit unsigned data values (LWORD, ULINT, MlpiLogicType) to the mem...
MLPIRESULT mlpiLogicWriteVariableBySymbolChar(const MLPIHANDLE connection, const WCHAR16 *symbol, const CHAR data)
This function writes a given 8-bit signed value (SINT, MlpiLogicType) to a variable by symbolic acces...
unsigned long MLPIHANDLE
common MLPI-API handle value
1 Byte signed short integer (CHAR)
MLPIRESULT mlpiLogicReadVariableBySymbolBool8(const MLPIHANDLE connection, const WCHAR16 *symbol, BOOL8 *data)
This function reads a boolean value (BOOL, MlpiLogicType) from a variable by symbolic access...
This event raises on end of 'online change application' sequence.
Capability to execute the operation 'stop application'.
Symbolic access unsupported.
MLPIRESULT mlpiLogicGetTaskInfoOfApplication(const MLPIHANDLE connection, const WCHAR16 *application, MlpiApplicationTaskInfo *taskInfo, const ULONG numElements, ULONG *numElementsRet=0)
This function will return information about all running IEC tasks of an application.
Symbolic access unsupported.
MLPIRESULT mlpiLogicWriteMemoryAreaChar(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, const CHAR data)
This function writes the 8-bit signed data value (SINT, MlpiLogicType) to the memory area (MlpiApplic...
MlpiApplicationMemoryArea
This enumeration defines the memory areas 'Ix' (Input), 'Qx' (Output) and 'Mx' (Marker) of an applica...
Symbolic access unsupported.
MLPIRESULT mlpiLogicWriteVariableBySymbolBool8(const MLPIHANDLE connection, const WCHAR16 *symbol, const BOOL8 data)
This function writes a given Boolean value (BOOL, MlpiLogicType) to a variable by symbolic access...
MLPIRESULT mlpiLogicReadVariableBySymbolArrayUllong(const MLPIHANDLE connection, const WCHAR16 *symbol, ULLONG *data, const ULONG numElements, ULONG *numElementsRet)
This function reads an array of 64-bit unsigned values (LWORD, ULINT, MlpiLogicType) from a variable ...
#define MLPI_APPLICATION_MAX_LENGTH_OF_TASK_NAME
Maximum length of name of a task.
MLPIRESULT mlpiLogicRunSingleCycleApplication(const MLPIHANDLE connection, const WCHAR16 *application=0)
This function will run an application for one single cycle.
This event raises on begin of 'delete application' sequence.
MLPIRESULT mlpiLogicWriteMemoryAreaShort(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, const SHORT data)
This function writes the 16-bit signed data value (INT, MlpiLogicType) to the memory area (MlpiApplic...
struct MlpiApplicationInfo MlpiApplicationInfo
This structure defines the information about the application using mlpiLogicGetInfoOfApplication.
This event raises on end of 'download application' sequence.
The application is halted on breakpoint.
MLPIRESULT mlpiLogicReadMemoryAreaArrayDouble(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, DOUBLE *data, const ULONG numElements, ULONG *numElementsRet)
This function reads an array of 64-bit floating point data values (double precision, LREAL, MlpiLogicType) from the memory area (MlpiApplicationMemoryArea).
Reset cold of application, all global data and (!) retain data is reset to default.
MLPIRESULT mlpiLogicReadMemoryAreaArrayShort(const MLPIHANDLE connection, const WCHAR16 *application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, SHORT *data, const ULONG numElements, ULONG *numElementsRet)
This function reads an array of 16-bit signed data values (INT, MlpiLogicType) from the memory area (...