Go to the source code of this file.
Typedefs | |
typedef signed char | BOOL8 |
typedef char | CHAR |
typedef unsigned char | UCHAR |
typedef short | SHORT |
typedef unsigned short | USHORT |
typedef long | LONG |
typedef unsigned long | ULONG |
typedef long long | LLONG |
typedef unsigned long long | ULLONG |
typedef float | FLOAT |
typedef double | DOUBLE |
typedef wchar_t | WCHAR16 |
typedef long | MLPIRESULT |
typedef unsigned long | MLPIHANDLE |
typedef unsigned long long | MLPITASKHANDLE |
typedef unsigned long | PROCESSHANDLE |
typedef BOOL8 | MLPI_DATA_ALIGN(1) MLPI_IEC_BOOL |
typedef struct MlpiDateAndTime | MlpiDateAndTime |
typedef struct MlpiVersion | MlpiVersion |
Enumerations |
Definition in file mlpiGlobal.h.
#define MLPI_STRUCT_ALIGN_BOOL8 MLPI_DATA_ALIGN(1) |
1 byte boolean, aligned within structs to MLPI data type BOOL8
Definition at line 287 of file mlpiGlobal.h.
#define MLPI_STRUCT_ALIGN_CHAR MLPI_DATA_ALIGN(1) |
1 byte signed integer, aligned within structs to MLPI data type CHAR
Definition at line 289 of file mlpiGlobal.h.
#define MLPI_STRUCT_ALIGN_SHORT MLPI_DATA_ALIGN(2) |
2 byte signed integer, aligned within structs to MLPI data type SHORT
Definition at line 290 of file mlpiGlobal.h.
#define MLPI_STRUCT_ALIGN_LONG MLPI_DATA_ALIGN(4) |
4 byte signed integer, aligned within structs to MLPI data type LONG
Definition at line 291 of file mlpiGlobal.h.
#define MLPI_STRUCT_ALIGN_LLONG MLPI_DATA_ALIGN(8) |
8 byte signed integer, aligned within structs to MLPI data type LLONG
Definition at line 292 of file mlpiGlobal.h.
#define MLPI_STRUCT_ALIGN_UCHAR MLPI_DATA_ALIGN(1) |
1 byte unsigned integer, aligned within structs to MLPI data type UCHAR
Definition at line 294 of file mlpiGlobal.h.
#define MLPI_STRUCT_ALIGN_USHORT MLPI_DATA_ALIGN(2) |
2 byte unsigned integer, aligned within structs to MLPI data type USHORT
Definition at line 295 of file mlpiGlobal.h.
#define MLPI_STRUCT_ALIGN_ULONG MLPI_DATA_ALIGN(4) |
4 byte unsigned integer, aligned within structs to MLPI data type ULONG
Definition at line 296 of file mlpiGlobal.h.
#define MLPI_STRUCT_ALIGN_ULLONG MLPI_DATA_ALIGN(8) |
8 byte unsigned integer, aligned within structs to MLPI data type ULLONG
Definition at line 297 of file mlpiGlobal.h.
#define MLPI_STRUCT_ALIGN_FLOAT MLPI_DATA_ALIGN(4) |
4 byte floating point, aligned within structs to MLPI data type FLOAT
Definition at line 299 of file mlpiGlobal.h.
#define MLPI_STRUCT_ALIGN_DOUBLE MLPI_DATA_ALIGN(8) |
8 byte floating point, aligned within structs to MLPI data type DOUBLE
Definition at line 300 of file mlpiGlobal.h.
#define MLPI_STRUCT_ALIGN_ENUM MLPI_DATA_ALIGN(4) |
enumeration, aligned within structs to 32 bit
Definition at line 302 of file mlpiGlobal.h.
#define MLPI_STRUCT_ALIGN_WCHAR16 MLPI_DATA_ALIGN(2) |
2 byte char, aligned within structs to MLPI data type WCHAR16
Definition at line 304 of file mlpiGlobal.h.
#define MLPI_STRUCT_ALIGN_STRUCT |
structure, dummy
Definition at line 306 of file mlpiGlobal.h.
#define MLPI_S_OK ((MLPIRESULT) 0x00360000L) |
Return code "everything okay".
Definition at line 363 of file mlpiGlobal.h.
#define MLPI_E_FAIL ((MLPIRESULT) 0xF0360001L) |
General error during function call.
Definition at line 364 of file mlpiGlobal.h.
#define MLPI_E_NOTSUPPORTED ((MLPIRESULT) 0xF0360002L) |
The given function is not supported yet.
Definition at line 365 of file mlpiGlobal.h.
#define MLPI_E_INVALIDARG ((MLPIRESULT) 0xF0360003L) |
Invalid argument given to method.
Definition at line 366 of file mlpiGlobal.h.
#define MLPI_E_OUTOFMEMORY ((MLPIRESULT) 0xF0360004L) |
Out of memory or resources (RAM, sockets, handles, disk space ...).
Definition at line 367 of file mlpiGlobal.h.
#define MLPI_E_TIMEOUT ((MLPIRESULT) 0xF0360005L) |
Timeout during function call.
Definition at line 368 of file mlpiGlobal.h.
#define MLPI_E_SERVEREXCEPTION ((MLPIRESULT) 0xF0360006L) |
System exception on control side.
Definition at line 369 of file mlpiGlobal.h.
#define MLPI_E_CONNECTFAILED ((MLPIRESULT) 0xF0360007L) |
Connection failed.
Definition at line 370 of file mlpiGlobal.h.
#define MLPI_E_CREATEERROR ((MLPIRESULT) 0xF0360008L) |
Error creating the resource.
Definition at line 371 of file mlpiGlobal.h.
#define MLPI_E_SYSTEMERROR ((MLPIRESULT) 0xF0360009L) |
System error during execution.
Definition at line 372 of file mlpiGlobal.h.
#define MLPI_E_BUFFERTOOSHORT ((MLPIRESULT) 0xF036000AL) |
Given buffer is too short.
Definition at line 373 of file mlpiGlobal.h.
#define MLPI_E_INVALIDSIGNATURE ((MLPIRESULT) 0xF036000BL) |
Invalid signature.
Definition at line 374 of file mlpiGlobal.h.
#define MLPI_E_STARTERROR ((MLPIRESULT) 0xF036000CL) |
Error during start of functionality.
Definition at line 375 of file mlpiGlobal.h.
#define MLPI_E_WATCHDOGWARNING ((MLPIRESULT) 0xF036000DL) |
Watchdog warning occurred.
Definition at line 376 of file mlpiGlobal.h.
#define MLPI_E_WATCHDOGERROR ((MLPIRESULT) 0xF536000EL) |
Watchdog error occurred.
Definition at line 377 of file mlpiGlobal.h.
#define MLPI_E_UNIMPLEMENTED ((MLPIRESULT) 0xF036000FL) |
The given function is not implemented on this specific device.
Definition at line 378 of file mlpiGlobal.h.
#define MLPI_E_LIMIT_MIN ((MLPIRESULT) 0xF0360010L) |
The minimum of a limitation is exceeded.
Definition at line 379 of file mlpiGlobal.h.
#define MLPI_E_LIMIT_MAX ((MLPIRESULT) 0xF0360011L) |
The maximum of a limitation is exceeded.
Definition at line 380 of file mlpiGlobal.h.
#define MLPI_E_VERSION ((MLPIRESULT) 0xF0360012L) |
Version conflict.
Definition at line 381 of file mlpiGlobal.h.
#define MLPI_E_DEPRECATED ((MLPIRESULT) 0xF0360013L) |
Deprecated. The lib or function is no longer supported.
Definition at line 382 of file mlpiGlobal.h.
#define MLPI_E_PERMISSION ((MLPIRESULT) 0xF0360014L) |
Request declined due to missing permission rights.
Definition at line 383 of file mlpiGlobal.h.
#define MLPI_E_TYPE_MISSMATCH ((MLPIRESULT) 0xF0360015L) |
Type mismatch, present type doesn't match requested type.
Definition at line 384 of file mlpiGlobal.h.
#define MLPI_E_SIZE_MISSMATCH ((MLPIRESULT) 0xF0360016L) |
Size mismatch, present size doesn't match requested size.
Definition at line 385 of file mlpiGlobal.h.
#define MLPI_E_INVALID_HANDLE ((MLPIRESULT) 0xF0360017L) |
Invalid handle argument or NULL pointer argument.
Definition at line 386 of file mlpiGlobal.h.
#define MLPI_E_NOCONNECTION ((MLPIRESULT) 0xF0360018L) |
The connection is not established, no longer established or has been quit by peer.
Definition at line 387 of file mlpiGlobal.h.
#define MLPI_E_RD_WR_PROTECTION ((MLPIRESULT) 0xF0360019L) |
Request declined due to read or write protection.
Definition at line 388 of file mlpiGlobal.h.
#define MLPI_E_INVALID_FLOATINGPOINT ((MLPIRESULT) 0xF036001AL) |
Invalid floating point number.
Definition at line 389 of file mlpiGlobal.h.
#define MLPI_E_NOTINITIALIZED ((MLPIRESULT) 0xF036001BL) |
Object not initialized yet.
Definition at line 390 of file mlpiGlobal.h.
#define MLPI_E_STREAM_OUT_OF_SYNC ((MLPIRESULT) 0xF036001CL) |
Send / Receive stream out of synchronization.
Definition at line 391 of file mlpiGlobal.h.
#define MLPI_E_INVALID_PRIVATEKEY_FILE ((MLPIRESULT) 0xF036001DL) |
The given private key file is broken or not existing.
Definition at line 392 of file mlpiGlobal.h.
#define MLPI_E_INVALID_CERTIFICATE_FILE ((MLPIRESULT) 0xF036001EL) |
The given certificate key file is broken or not existing.
Definition at line 393 of file mlpiGlobal.h.
#define MLPI_E_KEYPAIR_MISSMATCH ((MLPIRESULT) 0xF036001FL) |
The given certificate does not match the given private key.
Definition at line 394 of file mlpiGlobal.h.
#define MLPI_E_TLS_HANDSHAKE_FAILED ((MLPIRESULT) 0xF0360020L) |
The TLS handshake was not successful.
Definition at line 395 of file mlpiGlobal.h.
#define MLPI_E_GENERAL_AC_ERROR ((MLPIRESULT) 0xF0360021L) |
General Access Control Error.
Definition at line 396 of file mlpiGlobal.h.
#define MLPI_E_POLICY_VIOLATION_AC ((MLPIRESULT) 0xF0360022L) |
A violation in the user policies occurred.
Definition at line 397 of file mlpiGlobal.h.
#define MLPI_E_USER_ALREADY_EXISTS ((MLPIRESULT) 0xF0360023L) |
The given username is already in use.
Definition at line 398 of file mlpiGlobal.h.
#define MLPI_E_GROUP_ALREADY_EXISTS ((MLPIRESULT) 0xF0360024L) |
The given groupname is already in use.
Definition at line 399 of file mlpiGlobal.h.
#define MLPI_E_MEMBERSHIP_ALREADY_EXISTS ((MLPIRESULT) 0xF0360025L) |
The given user is already member of the given group.
Definition at line 400 of file mlpiGlobal.h.
#define MLPI_E_USER_NOT_EXISTING ((MLPIRESULT) 0xF0360026L) |
The given user does not exist on the control.
Definition at line 401 of file mlpiGlobal.h.
#define MLPI_E_GROUP_NOT_EXISTING ((MLPIRESULT) 0xF0360027L) |
The given group does not exist on the control.
Definition at line 402 of file mlpiGlobal.h.
#define MLPI_E_MEMBERSHIP_NOT_EXISTING ((MLPIRESULT) 0xF0360028L) |
The given user is not member of the given group.
Definition at line 403 of file mlpiGlobal.h.
#define MLPI_E_PERMISSION_NOT_EXISTING ((MLPIRESULT) 0xF0360029L) |
The given permission does not exist.
Definition at line 404 of file mlpiGlobal.h.
#define MLPI_SUCCEEDED | ( | hr | ) | ((MLPIRESULT)(hr) >= 0) |
Returns true if given error code was successful.
Definition at line 406 of file mlpiGlobal.h.
#define MLPI_FAILED | ( | hr | ) | ((MLPIRESULT)(hr) < 0) |
Returns true if given error code was not successful.
Definition at line 407 of file mlpiGlobal.h.
#define MLPI_INVALIDHANDLE ((MLPIHANDLE) 0xFFFFFFFF) |
Invalid handle value.
Definition at line 416 of file mlpiGlobal.h.
typedef signed char BOOL8 |
1 byte boolean
Definition at line 158 of file mlpiGlobal.h.
typedef char CHAR |
1 byte signed integer
Definition at line 159 of file mlpiGlobal.h.
typedef unsigned char UCHAR |
1 byte unsigned integer
Definition at line 160 of file mlpiGlobal.h.
typedef short SHORT |
2 byte signed integer
Definition at line 161 of file mlpiGlobal.h.
typedef unsigned short USHORT |
2 byte unsigned integer
Definition at line 162 of file mlpiGlobal.h.
typedef long LONG |
4 byte signed integer
Definition at line 167 of file mlpiGlobal.h.
typedef unsigned long ULONG |
4 byte unsigned integer
Definition at line 168 of file mlpiGlobal.h.
typedef long long LLONG |
8 byte signed integer
Definition at line 170 of file mlpiGlobal.h.
typedef unsigned long long ULLONG |
8 byte unsigned integer
Definition at line 171 of file mlpiGlobal.h.
typedef float FLOAT |
4 byte floating point
Definition at line 172 of file mlpiGlobal.h.
typedef double DOUBLE |
8 byte floating point
Definition at line 177 of file mlpiGlobal.h.
typedef wchar_t WCHAR16 |
UTF16 string.
Definition at line 193 of file mlpiGlobal.h.
typedef long MLPIRESULT |
common MLPI-API return value
Definition at line 200 of file mlpiGlobal.h.
typedef unsigned long MLPIHANDLE |
common MLPI-API handle value
Definition at line 206 of file mlpiGlobal.h.
typedef unsigned long long MLPITASKHANDLE |
MLPI-API handle value used for tasks.
Definition at line 209 of file mlpiGlobal.h.
typedef unsigned long PROCESSHANDLE |
MLPI handle value used for a process.
Definition at line 211 of file mlpiGlobal.h.
typedef SHORT MLPI_DATA_ALIGN(2) MLPI_IEC_WSTRING |
1 byte boolean, aligned to IEC data type BOOL
2 byte signed integer, aligned to IEC data type WSTRING
1 byte signed integer, aligned to IEC data type STRING
2 byte signed integer, aligned to IEC data type ENUM
4 byte unsigned integer, aligned to IEC data type TIME_OF_DTAE
4 byte unsigned integer, aligned to IEC data type DATE_AND_TIME
4 byte unsigned integer, aligned to IEC data type DATE
4 byte unsigned integer, aligned to IEC data type TIME
8 byte floating point, aligned to IEC data type LREAL
4 byte floating point, aligned to IEC data type REAL
8 byte unsigned integer, aligned to IEC data type LWORD
4 byte unsigned integer, aligned to IEC data type DWORD
2 byte unsigned integer, aligned to IEC data type WORD
1 byte unsigned integer, aligned to IEC data type BYTE
8 byte unsigned integer, aligned to IEC data type ULINT
4 byte unsigned integer, aligned to IEC data type UDINT
2 byte unsigned integer, aligned to IEC data type UINT
1 byte unsigned integer, aligned to IEC data type USINT
8 byte signed integer, aligned to IEC data type LINT
4 byte signed integer, aligned to IEC data type DINT
2 byte signed integer, aligned to IEC data type INT
1 byte signed integer, aligned to IEC data type SINT
Definition at line 314 of file mlpiGlobal.h.
MlpiDateAndTime |
This structure defines the broken date and time information.
Elements of struct MlpiDateAndTime
Type | Element | Description | Example |
---|---|---|---|
SHORT | year | Year | 2000..2099 |
SHORT | month | Month | 1..12: 1==January, ..., 12==December |
SHORT | day | Day of month | 1..31 |
SHORT | hour | Hours after midnight | 0..23 |
SHORT | minute | Minutes after hour | 0..59 |
SHORT | second | Seconds after minute | 0..59 |
SHORT | milliSecond | Milliseconds after second | 0..999 |
SHORT | microSecond | Microseconds after millisecond | 0..999 |
SHORT | dayOfWeek | Day of week | 1..7: 1==Monday, ..., 7==Sunday |
SHORT | dayOfYear | Day of year | 1..366: 1==January 1, 365/366== December 31 |
MlpiVersion |
Describes the API version information. The build number counts continuously within a major release, all other elements count at the beginning, if a higher element is to be incremented.
Elements of struct MlpiVersion
Type | Element | Description |
---|---|---|
ULONG | major | Major release, changes of interfaces, behavior or significant changes of code may occur. |
ULONG | minor | Minor release, new features or a significant set of bug fixes may occur. |
ULONG | bugfix | Bugfixes of existing features. |
ULONG | patch | Patch of an existing release. |
ULONG | build | Build number. |
enum MlpiType |
This enumeration defines the basic types of as used by the MLPI.
Definition at line 217 of file mlpiGlobal.h.
enum MlpiProcessState |
This enumeration defines the state of a process.
Definition at line 254 of file mlpiGlobal.h.