Open Core Interface - MLPI
MLPI-MotionLogicProgrammingInterface(mlpiCore)  1.26.2
mlpiParameterLib.h
Go to the documentation of this file.
1 #ifndef __MLPIPARAMETERLIB_H__
2 #define __MLPIPARAMETERLIB_H__
3 
4 // -----------------------------------------------------------------------
5 // MLPI - <mlpiParameterLib.h>
6 // -----------------------------------------------------------------------
7 // Copyright (c) 2013 Bosch Rexroth. All rights reserved.
8 // Redistribution and use in source and binary forms of this MLPI software
9 // (SW) provided to you, with or without modification, are permitted
10 // without prior approval provided that the following conditions are met:
11 //
12 // 1. Redistributions of source code of SW must retain the above copyright
13 // notice, this list of conditions and the following disclaimer.
14 //
15 // 2. Redistributions in binary form of SW must reproduce the above copyright
16 // notice, this list of conditions and the following disclaimer in the
17 // documentation and/or other materials provided with the distribution.
18 //
19 // 3. User recognizes and acknowledges that it acquires no right,
20 // title or interest in or to any of the names or trademarks used in
21 // connection with the SW ("names") by virtue of this License and waives
22 // any right to or interest in the names. User recognizes and acknowledges
23 // that names of companies or names or products of companies displayed
24 // in the documentation of SW to indicate the interoperability of products
25 // with the SW are the names of their respective owners. The use of such
26 // names in the documentation of SW does not imply any sponsorship,
27 // approval, or endorsement by such companies of this product.
28 //
29 // 4. Modified code versions, i.e. any addition to or deletion from
30 // the substance or structure of the original code of the SW running
31 // the MLPI must be plainly marked as such and must not be misrepresented
32 // as being original SW.
33 //
34 // 5. The SW may only be used in connection with a Bosch Rexroth product.
35 //
36 // THIS INFORMATION IS PROVIDED BY BOSCH REXROTH CORPORATION "AS IS"
37 // AND WITHOUT WARRANTY OF ANY KIND, EXPRESSED OR IMPLIED, INCLUDING
38 // (BUT NOTLIMITED TO) ANY IMPLIED WARRANTIES OF MERCHANTABILITY,
39 // FITNESS FOR ANY PARTICULAR PURPOSE, OR NON-INFRINGEMENT. WHILE THE
40 // INFORMATION PROVIDED IS BELIEVED TO BE ACCURATE, IT MAY INCLUDE
41 // ERRORS OR INACCURACIES.
42 // SUBJECT TO COMPULSORY STATUTORY PROVISIONS OF THE GERMAN LAW AS
43 // THE APPLICABLE LAW FOR THIS LICENSE BOSCH REXROTH CORPORATION WILL
44 // NOT BE LIABLE FOR ANY DAMAGES OF ANY KIND ARISING FROM THE USE OF
45 // THE SOFTWARE DISTRIBUTED HEREUNDER, INCLUDING BUT NOT LIMITED TO
46 // DIRECT, INDIRECT, INCIDENTAL, PUNITIVE, AND CONSEQUENTIAL DAMAGES.
47 // -----------------------------------------------------------------------
48 //
58 //
59 // -----------------------------------------------------------------------
60 
61 
190 
201 
210 
218 
226 
236 
244 
252 
260 
268 
276 
407 
412 
413 
414 
415 // -----------------------------------------------------------------------
416 // GLOBAL INCLUDES
417 // -----------------------------------------------------------------------
418 
419 #include "mlpiGlobal.h"
420 
421 
422 
423 // -----------------------------------------------------------------------
424 // GLOBAL CONSTANTS
425 // -----------------------------------------------------------------------
426 
427 // A MLPI Parameter Identification Number (SIDN resp. EIDN) is build like this.
428 //
429 // +----------+----------+------+------+------+-----+-----+---------+
430 // | Instance | reserved | Type | SI | SE | S/P | Set | Block |
431 // +----------+----------+------+------+------+-----+-----+---------+
432 // 63 55 39 31 23 15 14 11 0
433 //
434 // The instance (address) will be used to assign a instance to parameter
435 // within a parameter configuration (-list).
436 //
437 //
438 
440 #define MLPI_SIDN_TYPE_DRIVE_S (0x0000000000ULL)
441 
443 #define MLPI_SIDN_TYPE_DRIVE_P (0x0000008000ULL)
444 
446 #define MLPI_SIDN_TYPE_AXIS (0x0100000000ULL)
447 
449 #define MLPI_SIDN_TYPE_CONTROL (0x0200000000ULL)
450 
452 #define MLPI_SIDN_TYPE_KINEMATIC (0x2B00000000ULL)
453 
455 #define MLPI_SIDN_TYPE_PROBE (0x2D00000000ULL)
456 
458 #define MLPI_SIDN_TYPE_POSLIMSWITCH (0x2E00000000ULL)
459 
461 #define MLPI_SIDN_TYPE_OSCILLOSCOPE (0x2F00000000ULL)
462 
464 #define MLPI_SIDN_INSTANCE_MASK (0xFF00000000000000ULL)
465 
467 #define MLPI_SIDN_TYPE_MASK (0xFF00008000ULL)
468 
470 #define MLPI_SIDN_SET_MASK (0x00007000)
471 
473 #define MLPI_SIDN_BLOCK_MASK (0x00000FFF)
474 
476 #define MLPI_SIDN_SE_MASK (0x00FF0000)
477 
479 #define MLPI_SIDN_SI_MASK (0xFF000000)
480 
481 
482 
483 // A MLPI address ident is build like this.
484 //
485 // +--------------+------+-------------+--------------+
486 // | reserved | mode | master adr. | slave adr. |
487 // +--------------+------+-------------+--------------+
488 // 63 39 31 15 0
489 //
490 
496 
498 #define MLPI_ADDRESS_MODE_LOGICAL (0x0000000000000000ULL)
499 
501 #define MLPI_ADDRESS_MODE_PHYSICAL (0x0000000000000001ULL)
502 
504 #define MLPI_ADDRESS_MODE_TOPOLOGICAL (0x0000000000000002ULL)
505 
509 #define MLPI_ADDRESS_MODE_LOGICAL_NATIVE (0x0000000000000003ULL)
510 
511 
513 #define MLPI_ADDRESS_SLAVE_MASK (0x000000000000FFFFULL)
514 
516 #define MLPI_ADDRESS_MASTER_MASK (0x00000000FFFF0000ULL)
517 
519 #define MLPI_ADDRESS_MODE_MASK (0x000000FF00000000ULL)
520 
521 
522 
523 
524 // -----------------------------------------------------------------------
525 // GLOBAL MACROS
526 // -----------------------------------------------------------------------
527 
529 
539 #define MLPI_SIDN(type, set, block, si, se) ( (ULLONG) ( \
540  ( ( ((ULLONG) type ) ) & MLPI_SIDN_TYPE_MASK ) | \
541  ( ( ((ULLONG) set ) << 12) & MLPI_SIDN_SET_MASK ) | \
542  ( ( ((ULLONG) block) ) & MLPI_SIDN_BLOCK_MASK ) | \
543  ( ( ((ULLONG) si ) << 24) & MLPI_SIDN_SI_MASK ) | \
544  ( ( ((ULLONG) se ) << 16) & MLPI_SIDN_SE_MASK ) ) )
545 
550 #define MLPI_SIDN_A(block) (MLPI_SIDN(MLPI_SIDN_TYPE_AXIS, 0, block, 0, 0))
551 
556 #define MLPI_SIDN_C(block) (MLPI_SIDN(MLPI_SIDN_TYPE_CONTROL, 0, block,0, 0))
557 
562 #define MLPI_SIDN_K(block) (MLPI_SIDN(MLPI_SIDN_TYPE_KINEMATIC, 0, block, 0, 0))
563 
568 #define MLPI_SIDN_M(block) (MLPI_SIDN(MLPI_SIDN_TYPE_PROBE, 0, block, 0, 0))
569 
574 #define MLPI_SIDN_N(block) (MLPI_SIDN(MLPI_SIDN_TYPE_POSLIMSWITCH, 0, block, 0, 0))
575 
580 #define MLPI_SIDN_O(block) (MLPI_SIDN(MLPI_SIDN_TYPE_OSCILLOSCOPE, 0, block, 0, 0))
581 
586 #define MLPI_SIDN_S(block) (MLPI_SIDN(MLPI_SIDN_TYPE_DRIVE_S, 0, block, 0, 0))
587 
592 #define MLPI_SIDN_P(block) (MLPI_SIDN(MLPI_SIDN_TYPE_DRIVE_P, 0, block, 0, 0))
593 
597 #define MLPI_SIDN_INST(sidn) ( (UCHAR) ((sidn & MLPI_SIDN_INSTANCE_MASK ) >> 56 ) )
598 
602 #define MLPI_SIDN_TYPE(sidn) ( (ULLONG) ((sidn & MLPI_SIDN_TYPE_MASK ) ) )
603 
607 #define MLPI_SIDN_SET(sidn) ( (UCHAR) ((sidn & MLPI_SIDN_SET_MASK ) >> 12 ) )
608 
612 #define MLPI_SIDN_BLOCK(sidn) ( (USHORT) ((sidn & MLPI_SIDN_BLOCK_MASK) ) )
613 
617 #define MLPI_SIDN_SI(sidn) ( (UCHAR) ((sidn & MLPI_SIDN_SI_MASK ) >> 24 ) )
618 
622 #define MLPI_SIDN_SE(sidn) ( (UCHAR) ((sidn & MLPI_SIDN_SE_MASK ) >> 16 ) )
623 
624 
625 
627 
636 #define MLPI_ADDRESS(mode, master, slave) ( (ULLONG) ( \
637  ( ( ((ULLONG) mode ) << 32 ) & MLPI_ADDRESS_MODE_MASK ) | \
638  ( ( ((ULLONG) master ) << 16 ) & MLPI_ADDRESS_MASTER_MASK ) | \
639  ( ( ((ULLONG) slave ) ) & MLPI_ADDRESS_SLAVE_MASK ) ) )
640 
641 
642 #define MLPI_PARAMETER_MASTER_ADDRESS(x) ( (USHORT)((x>>16) & 0xFFFF) )
643 #define MLPI_PARAMETER_SLAVE_ADDRESS(x) ( (USHORT) (x & 0xFFFF) )
644 #define MLPI_PARAMETER_ADDRESS_MODE(x) ( (UCHAR) (((ULLONG)x>>32) & 0x0F) )
645 
646 
647 
649 
651 #define MLPI_PARAMETER_EIDN_MAX_LENGTH_OF_NAME ( 60)
652 
654 #define MLPI_PARAMETER_EIDN_MAX_LENGTH_OF_UNIT ( 12)
655 
657 #define MLPI_PARAMETER_EIDN_MAX_LENGTH_OF_DATA (65532)
658 
659 
660 
661 // -----------------------------------------------------------------------
662 // GLOBAL TYPEDEFS
663 // -----------------------------------------------------------------------
664 
668 {
671 }MlpiParamImExportStatus;
672 
676 {
685 
686 // message packing follows 8-byte natural alignment
687 #if !defined(TARGET_OS_VXWORKS)
688 #pragma pack(push,8)
689 #endif
690 
699 typedef struct MlpiSidnError
700 {
701  ULLONG parameterNumber;
702  ULONG errorCode;
703  ULONG reserved;
705 
726 typedef struct MlpiReadEverything
727 {
728  // Input Parameters
729  ULLONG address;
730  ULLONG sidn;
731 
732  // Output Parameters
733  ULONG validElements;
734  ULONG dataStatus;
737  ULONG nameOffset;
738  ULONG attribute;
739  ULONG unitOffset;
740  ULONG minOffset;
741  ULONG maxOffset;
742  ULONG dataLength;
743  ULONG dataOffset;
744  ULONG dataSize;
745  ULONG maxDataSize;
746 
747  MLPIRESULT result;
749 
759 typedef struct MlpiParamProcessStatus
760 {
761  MlpiParameterProcessType processType;
762  MlpiProcessState processState;
763  MLPIRESULT processResult;
765 
774 typedef struct MlpiParamWriteAccess
775 {
776  ULLONG address;
777  ULLONG sidn;
779 
780 
781 #if !defined(TARGET_OS_VXWORKS)
782 #pragma pack(pop)
783 #endif
784 
786 
787 
788 // -----------------------------------------------------------------------
789 // GLOBAL EXPORTS
790 // -----------------------------------------------------------------------
791 #ifdef MLPI_API
792  #undef MLPI_API
793 #endif
794 
795 #if defined(TARGET_OS_WINNT)
796  #if defined(MLPI_EXPORTS)
797  #define MLPI_API __declspec(dllexport)
798  #elif defined(MLPI_IMPORTS)
799  #define MLPI_API __declspec(dllimport)
800  #else
801  #define MLPI_API
802  #endif
803 #else
804  #if defined(MLPI_EXPORTS)
805  #define MLPI_API __attribute__ ((visibility("default")))
806  #elif defined(MLPI_IMPORTS)
807  #define MLPI_API
808  #else
809  #define MLPI_API
810  #endif
811 #endif
812 
813 
814 #ifdef __cplusplus
815 extern "C" {
816 #endif
817 
834 MLPI_API MLPIRESULT mlpiParameterReadName(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, WCHAR16 *name, const ULONG numElements);
835 
836 
852 MLPI_API MLPIRESULT mlpiParameterReadAttribute(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULONG *attribute);
853 
854 
871 MLPI_API MLPIRESULT mlpiParameterReadUnit(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, WCHAR16 *unit, const ULONG numElements);
872 
873 
888 MLPI_API MLPIRESULT mlpiParameterReadMinimumChar(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, CHAR *data);
889 
890 
905 MLPI_API MLPIRESULT mlpiParameterReadMinimumUchar(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, UCHAR *data);
906 
907 
922 MLPI_API MLPIRESULT mlpiParameterReadMinimumShort(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, SHORT *data);
923 
924 
939 MLPI_API MLPIRESULT mlpiParameterReadMinimumUshort(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, USHORT *data);
940 
941 
956 MLPI_API MLPIRESULT mlpiParameterReadMinimumLong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LONG *data);
957 
958 
973 MLPI_API MLPIRESULT mlpiParameterReadMinimumUlong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULONG *data);
974 
975 
991 MLPI_API MLPIRESULT mlpiParameterReadMinimumLlong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LLONG *data);
992 
993 
1009 MLPI_API MLPIRESULT mlpiParameterReadMinimumUllong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULLONG *data);
1010 
1011 
1026 MLPI_API MLPIRESULT mlpiParameterReadMinimumFloat(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, FLOAT *data);
1027 
1028 
1043 MLPI_API MLPIRESULT mlpiParameterReadMinimumDouble(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, DOUBLE *data);
1044 
1045 
1063 MLPI_API MLPIRESULT mlpiParameterReadMinimumString(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, WCHAR16 *data, const ULONG numElements, ULONG *numElementsRet);
1064 
1065 
1080 MLPI_API MLPIRESULT mlpiParameterReadMaximumChar(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, CHAR *data);
1081 
1082 
1097 MLPI_API MLPIRESULT mlpiParameterReadMaximumUchar(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, UCHAR *data);
1098 
1099 
1114 MLPI_API MLPIRESULT mlpiParameterReadMaximumShort(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, SHORT *data);
1115 
1116 
1131 MLPI_API MLPIRESULT mlpiParameterReadMaximumUshort(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, USHORT *data);
1132 
1133 
1148 MLPI_API MLPIRESULT mlpiParameterReadMaximumLong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LONG *data);
1149 
1150 
1165 MLPI_API MLPIRESULT mlpiParameterReadMaximumUlong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULONG *data);
1166 
1167 
1183 MLPI_API MLPIRESULT mlpiParameterReadMaximumLlong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LLONG *data);
1184 
1185 
1201 MLPI_API MLPIRESULT mlpiParameterReadMaximumUllong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULLONG *data);
1202 
1203 
1218 MLPI_API MLPIRESULT mlpiParameterReadMaximumFloat(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, FLOAT *data);
1219 
1220 
1235 MLPI_API MLPIRESULT mlpiParameterReadMaximumDouble(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, DOUBLE *data);
1236 
1237 
1255 MLPI_API MLPIRESULT mlpiParameterReadMaximumString(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, WCHAR16 *data, const ULONG numElements, ULONG *numElementsRet);
1256 
1257 
1272 MLPI_API MLPIRESULT mlpiParameterReadDataShort(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, SHORT *data);
1273 
1274 
1289 MLPI_API MLPIRESULT mlpiParameterReadDataUshort(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, USHORT *data);
1290 
1291 
1306 MLPI_API MLPIRESULT mlpiParameterReadDataLong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LONG *data);
1307 
1308 
1323 MLPI_API MLPIRESULT mlpiParameterReadDataUlong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULONG *data);
1324 
1325 
1341 MLPI_API MLPIRESULT mlpiParameterReadDataLlong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LLONG *data);
1342 
1343 
1358 MLPI_API MLPIRESULT mlpiParameterReadDataUllong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULLONG *data);
1359 
1360 
1375 MLPI_API MLPIRESULT mlpiParameterReadDataFloat(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, FLOAT *data);
1376 
1377 
1392 MLPI_API MLPIRESULT mlpiParameterReadDataDouble(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, DOUBLE *data);
1393 
1394 
1412 MLPI_API MLPIRESULT mlpiParameterReadDataString(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, WCHAR16 *data, const ULONG numElements, ULONG *numElementsRet);
1413 
1414 
1436 MLPI_API MLPIRESULT mlpiParameterReadDataArrayVoid(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, void *data, const ULONG dataSize, ULONG *dataSizeRet);
1437 
1438 
1457 MLPI_API MLPIRESULT mlpiParameterReadDataArrayChar(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, CHAR *data, const ULONG numElements, ULONG *numElementsRet);
1458 
1459 
1478 MLPI_API MLPIRESULT mlpiParameterReadDataArrayUchar(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, UCHAR *data, const ULONG numElements, ULONG *numElementsRet);
1479 
1480 
1499 MLPI_API MLPIRESULT mlpiParameterReadDataArrayShort(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, SHORT *data, const ULONG numElements, ULONG *numElementsRet);
1500 
1501 
1520 MLPI_API MLPIRESULT mlpiParameterReadDataArrayUshort(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, USHORT *data, const ULONG numElements, ULONG *numElementsRet);
1521 
1522 
1541 MLPI_API MLPIRESULT mlpiParameterReadDataArrayLong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LONG *data, const ULONG numElements, ULONG *numElementsRet);
1542 
1543 
1562 MLPI_API MLPIRESULT mlpiParameterReadDataArrayUlong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULONG *data, const ULONG numElements, ULONG *numElementsRet);
1563 
1564 
1584 MLPI_API MLPIRESULT mlpiParameterReadDataArrayLlong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LLONG *data, const ULONG numElements, ULONG *numElementsRet);
1585 
1586 
1605 MLPI_API MLPIRESULT mlpiParameterReadDataArrayUllong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULLONG *data, const ULONG numElements, ULONG *numElementsRet);
1606 
1607 
1626 MLPI_API MLPIRESULT mlpiParameterReadDataArrayFloat(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, FLOAT *data, const ULONG numElements, ULONG *numElementsRet);
1627 
1628 
1647 MLPI_API MLPIRESULT mlpiParameterReadDataArrayDouble(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, DOUBLE *data, const ULONG numElements, ULONG *numElementsRet);
1648 
1649 
1664 MLPI_API MLPIRESULT mlpiParameterWriteDataShort(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const SHORT data);
1665 
1666 
1681 MLPI_API MLPIRESULT mlpiParameterWriteDataUshort(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const USHORT data);
1682 
1683 
1698 MLPI_API MLPIRESULT mlpiParameterWriteDataLong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const LONG data);
1699 
1700 
1715 MLPI_API MLPIRESULT mlpiParameterWriteDataUlong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const ULONG data);
1716 
1717 
1733 MLPI_API MLPIRESULT mlpiParameterWriteDataLlong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const LLONG data);
1734 
1735 
1751 MLPI_API MLPIRESULT mlpiParameterWriteDataUllong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const ULLONG data);
1752 
1753 
1768 MLPI_API MLPIRESULT mlpiParameterWriteDataFloat(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const FLOAT data);
1769 
1770 
1785 MLPI_API MLPIRESULT mlpiParameterWriteDataDouble(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const DOUBLE data);
1786 
1787 
1802 MLPI_API MLPIRESULT mlpiParameterWriteDataString(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const WCHAR16 *data);
1803 
1804 
1824 MLPI_API MLPIRESULT mlpiParameterWriteDataArrayVoid(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const void *data, const ULONG dataSize);
1825 
1826 
1842 MLPI_API MLPIRESULT mlpiParameterWriteDataArrayChar(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const CHAR *data, const ULONG numElements);
1843 
1844 
1860 MLPI_API MLPIRESULT mlpiParameterWriteDataArrayUchar(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const UCHAR *data, const ULONG numElements);
1861 
1862 
1879 MLPI_API MLPIRESULT mlpiParameterWriteDataArrayShort(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const SHORT *data, const ULONG numElements);
1880 
1881 
1897 MLPI_API MLPIRESULT mlpiParameterWriteDataArrayUshort(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const USHORT *data, const ULONG numElements);
1898 
1899 
1915 MLPI_API MLPIRESULT mlpiParameterWriteDataArrayLong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const LONG *data, const ULONG numElements);
1916 
1917 
1933 MLPI_API MLPIRESULT mlpiParameterWriteDataArrayUlong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const ULONG *data, const ULONG numElements);
1934 
1935 
1952 MLPI_API MLPIRESULT mlpiParameterWriteDataArrayLlong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const LLONG *data, const ULONG numElements);
1953 
1954 
1971 MLPI_API MLPIRESULT mlpiParameterWriteDataArrayUllong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const ULLONG *data, const ULONG numElements);
1972 
1973 
1989 MLPI_API MLPIRESULT mlpiParameterWriteDataArrayFloat(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const FLOAT *data, const ULONG numElements);
1990 
1991 
2007 MLPI_API MLPIRESULT mlpiParameterWriteDataArrayDouble(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const DOUBLE *data, const ULONG numElements);
2008 
2009 
2024 MLPI_API MLPIRESULT mlpiParameterReadDefaultShort(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, SHORT *data);
2025 
2026 
2041 MLPI_API MLPIRESULT mlpiParameterReadDefaultUshort(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, USHORT *data);
2042 
2043 
2058 MLPI_API MLPIRESULT mlpiParameterReadDefaultLong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LONG *data);
2059 
2060 
2075 MLPI_API MLPIRESULT mlpiParameterReadDefaultUlong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULONG *data);
2076 
2077 
2093 MLPI_API MLPIRESULT mlpiParameterReadDefaultLlong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LLONG *data);
2094 
2095 
2110 MLPI_API MLPIRESULT mlpiParameterReadDefaultUllong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULLONG *data);
2111 
2112 
2127 MLPI_API MLPIRESULT mlpiParameterReadDefaultFloat(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, FLOAT *data);
2128 
2129 
2144 MLPI_API MLPIRESULT mlpiParameterReadDefaultDouble(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, DOUBLE *data);
2145 
2146 
2164 MLPI_API MLPIRESULT mlpiParameterReadDefaultString(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, WCHAR16 *data, const ULONG numElements, ULONG *numElementsRet);
2165 
2166 
2187 MLPI_API MLPIRESULT mlpiParameterReadDataStatus(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, BOOL8 *status);
2188 
2189 
2203 MLPI_API MLPIRESULT mlpiParameterCommand(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn);
2204 
2205 
2224 MLPI_API MLPIRESULT mlpiParameterReadCommandStatus(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, USHORT *status);
2225 
2226 
2249 MLPI_API MLPIRESULT mlpiParameterReadListLength(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULONG *numElements, ULONG *numMaxElements, ULONG *elementSize);
2250 
2251 
2284 MLPI_API MLPIRESULT mlpiParameterImportFile(const MLPIHANDLE connection, const WCHAR16* path, MlpiSidnError* errorList, const ULONG numElements, ULONG* numElementsRet, const WCHAR16* mapping);
2285 
2286 
2322 MLPI_API MLPIRESULT mlpiParameterExportFile(const MLPIHANDLE connection, const WCHAR16* path, const WCHAR16* exportPattern, MlpiSidnError* errorList, const ULONG numElements, ULONG* numElementsRet);
2323 
2324 
2603 MLPI_API MLPIRESULT mlpiParameterReadEverything(const MLPIHANDLE connection, MlpiReadEverything* readEverything, const ULONG numElements, UCHAR* data, const ULONG dataSize);
2604 
2605 
2638 MLPI_API MLPIRESULT mlpiParameterExportFileStartProcess(const MLPIHANDLE connection, const WCHAR16* path, const WCHAR16* exportPattern, PROCESSHANDLE* process);
2639 
2640 
2672 MLPI_API MLPIRESULT mlpiParameterImportFileStartProcess(const MLPIHANDLE connection, const WCHAR16* path, const WCHAR16* mapping, PROCESSHANDLE* process);
2673 
2674 
2710 MLPI_API MLPIRESULT mlpiParameterImportExportStatus(const MLPIHANDLE connection, const PROCESSHANDLE process, MlpiParamProcessStatus* status, ULONG* currentCount, ULONG* expectedCount, ULONG* errorsCount, MlpiSidnError* errorList, ULONG numElements);
2711 
2712 
2744 MLPI_API MLPIRESULT mlpiParameterImportExportGetInfo(const MLPIHANDLE connection, const PROCESSHANDLE process, WCHAR16* pattern, ULONG numElementsPattern, WCHAR16* file, ULONG numElementsFile);
2745 
2746 
2771 MLPI_API MLPIRESULT mlpiParameterImportExportAbort(const MLPIHANDLE connection, const PROCESSHANDLE process);
2772 
2773 
2802 MLPI_API MLPIRESULT mlpiParameterWriteAccessSetup(const MLPIHANDLE connection, MlpiParamWriteAccess* writeAccess, const ULONG numElements, PROCESSHANDLE* process);
2803 
2804 
2854 MLPI_API MLPIRESULT mlpiParameterWriteAccessStatus(const MLPIHANDLE connection, const PROCESSHANDLE process, const BOOL8 waitForWriteAccess, const ULONG timeout, MlpiParamWriteAccess* writeAccess, const ULONG numElements, ULONG* numElementsRet);
2855 
2856 
2883 MLPI_API MLPIRESULT mlpiParameterWriteAccessAbort(const MLPIHANDLE connection, const PROCESSHANDLE process);
2884 
2885 
2886 #ifdef __cplusplus
2887 }
2888 #endif
2889 
2890 
2891 
2892 #endif // endof: #ifndef __MLPIPARAMETERLIB_H__
2893 
MLPIRESULT mlpiParameterReadDataDouble(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, DOUBLE *data)
This function reads the 64-bit floating point data value (double precision) of a parameter.
MLPIRESULT mlpiParameterReadMinimumUlong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULONG *data)
This function reads the 32-bit unsigned minimum value of a parameter.
unsigned char UCHAR
1 byte unsigned integer
Definition: mlpiGlobal.h:160
MLPIRESULT mlpiParameterReadDataUlong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULONG *data)
This function reads the 32-bit unsigned data value of a parameter.
MLPIRESULT mlpiParameterReadDataString(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, WCHAR16 *data, const ULONG numElements, ULONG *numElementsRet)
This function reads the value of a parameter and returns it as string. A conversion from other types ...
MLPIRESULT mlpiParameterReadDataArrayVoid(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, void *data, const ULONG dataSize, ULONG *dataSizeRet)
This function reads the data value of a parameter.
MLPIRESULT mlpiParameterReadMaximumLong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LONG *data)
This function reads the 32-bit signed maximum value of a parameter.
MLPIRESULT mlpiParameterReadDefaultUshort(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, USHORT *data)
This function reads the 16-bit unsigned default value of a parameter.
MLPIRESULT mlpiParameterCommand(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn)
This function sets a command through a parameter. The command will be executed and the function will ...
MLPIRESULT mlpiParameterReadDataLlong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LLONG *data)
This function reads the 64-bit signed data value of a parameter.
unsigned long long ULLONG
8 byte unsigned integer
Definition: mlpiGlobal.h:171
MLPIRESULT mlpiParameterWriteDataString(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const WCHAR16 *data)
This function writes a given UTF16 string to a parameter.
int LONG
4 byte signed integer
Definition: mlpiGlobal.h:164
MLPIRESULT mlpiParameterExportFileStartProcess(const MLPIHANDLE connection, const WCHAR16 *path, const WCHAR16 *exportPattern, PROCESSHANDLE *process)
This function exports parameters to a file on CF card in a asynchronous way. In string &#39;exportPattern...
MLPIRESULT mlpiParameterWriteDataUlong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const ULONG data)
This function writes a given 32-bit unsigned data value to a parameter.
char CHAR
1 byte signed integer
Definition: mlpiGlobal.h:159
MLPIRESULT mlpiParameterReadDataArrayFloat(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, FLOAT *data, const ULONG numElements, ULONG *numElementsRet)
This function reads an array of 32-bit floating point data values (single precision) of a parameter...
MLPIRESULT mlpiParameterWriteAccessStatus(const MLPIHANDLE connection, const PROCESSHANDLE process, const BOOL8 waitForWriteAccess, const ULONG timeout, MlpiParamWriteAccess *writeAccess, const ULONG numElements, ULONG *numElementsRet)
This function reads the status of a write access monitoring process. The process has be initialized v...
MLPIRESULT mlpiParameterImportExportAbort(const MLPIHANDLE connection, const PROCESSHANDLE process)
This function stops a given parameter process.
MLPIRESULT mlpiParameterReadDefaultUllong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULLONG *data)
This function reads the 64-bit unsigned default value of a parameter.
MLPIRESULT mlpiParameterReadName(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, WCHAR16 *name, const ULONG numElements)
This function reads the name of a parameter (Parameter structure, sercos element 2).
signed char BOOL8
1 byte boolean
Definition: mlpiGlobal.h:158
MLPIRESULT mlpiParameterReadMinimumUchar(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, UCHAR *data)
This function reads the 8-bit unsigned minimum value of a parameter.
MlpiParameterCommandStatus
This enumeration defines the status of a command execution using mlpiParameterReadCommandStatus.
unsigned short USHORT
2 byte unsigned integer
Definition: mlpiGlobal.h:162
MLPIRESULT mlpiParameterReadDefaultLong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LONG *data)
This function reads the 32-bit signed default value of a parameter.
MLPIRESULT mlpiParameterReadMinimumShort(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, SHORT *data)
This function reads the 16-bit signed minimum value of a parameter.
MlpiProcessState
This enumeration defines the state of a process.
Definition: mlpiGlobal.h:254
MLPIRESULT mlpiParameterReadMinimumChar(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, CHAR *data)
This function reads the 8-bit signed minimum value of a parameter.
struct MlpiSidnError MlpiSidnError
This structure defines the information returned in case an error occurred during parameter import or ...
unsigned long PROCESSHANDLE
MLPI handle value used for a process.
Definition: mlpiGlobal.h:211
Procedure command has been executed correctly.
struct MlpiParamWriteAccess MlpiParamWriteAccess
This structure defines the information of an parameter used by function mlpiParameterWriteAccessSetup...
MLPIRESULT mlpiParameterReadMinimumLong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LONG *data)
This function reads the 32-bit signed minimum value of a parameter.
MLPIRESULT mlpiParameterReadDataUllong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULLONG *data)
This function reads the 64-bit unsigned data value of a parameter.
MLPIRESULT mlpiParameterWriteDataArrayLong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const LONG *data, const ULONG numElements)
This function writes an array of given 32-bit signed data values to a parameter.
MLPIRESULT mlpiParameterReadUnit(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, WCHAR16 *unit, const ULONG numElements)
This function reads the unit of a parameter (d structure, sercos element 4).
MLPIRESULT mlpiParameterWriteDataUshort(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const USHORT data)
This function writes a given 16-bit unsigned data value to a parameter.
MLPIRESULT mlpiParameterReadDataFloat(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, FLOAT *data)
This function reads the 32-bit floating point data value (single precision) of a parameter.
Procedure command is set.
MLPIRESULT mlpiParameterReadMinimumLlong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LLONG *data)
This function reads the 64-bit signed minimum value of a parameter.
MLPIRESULT mlpiParameterReadDataArrayDouble(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, DOUBLE *data, const ULONG numElements, ULONG *numElementsRet)
This function reads an array of 64-bit floating point data values (double precision) of a parameter...
MLPIRESULT mlpiParameterReadMinimumDouble(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, DOUBLE *data)
This function reads the 64-bit floating point minimum value (double precision) of a parameter...
MLPIRESULT mlpiParameterWriteDataArrayDouble(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const DOUBLE *data, const ULONG numElements)
This function writes an array of given 64-bit floating point data values (double precision) to a para...
MLPIRESULT mlpiParameterWriteDataDouble(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const DOUBLE data)
This function writes a given 64-bit floating point data value (double precision) to a parameter...
MlpiParameterProcessType
This enumeration defines the type of the parameter process.
MLPIRESULT mlpiParameterWriteDataArrayUllong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const ULLONG *data, const ULONG numElements)
This function writes an array of given 64-bit unsigned data values to a parameter.
struct MlpiParamProcessStatus MlpiParamProcessStatus
This structure defines the information about a parameter process status.
MLPIRESULT mlpiParameterWriteDataArrayFloat(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const FLOAT *data, const ULONG numElements)
This function writes an array of given 32-bit floating point data values (single precision) to a para...
short SHORT
2 byte signed integer
Definition: mlpiGlobal.h:161
MLPIRESULT mlpiParameterWriteDataLong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const LONG data)
This function writes a given 32-bit signed data value to a parameter.
MLPIRESULT mlpiParameterWriteDataShort(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const SHORT data)
This function writes a given 16-bit signed data value to a parameter.
MLPIRESULT mlpiParameterReadDataArrayUchar(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, UCHAR *data, const ULONG numElements, ULONG *numElementsRet)
This function reads an array of 8-bit unsigned data values of a parameter.
MLPIRESULT mlpiParameterWriteDataArrayUchar(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const UCHAR *data, const ULONG numElements)
This function writes an array of given 8-bit unsigned data values to a parameter. ...
MLPIRESULT mlpiParameterImportFile(const MLPIHANDLE connection, const WCHAR16 *path, MlpiSidnError *errorList, const ULONG numElements, ULONG *numElementsRet, const WCHAR16 *mapping)
This function imports a parameter file from CF-card. The string &#39;mapping&#39; can give information on whi...
MLPIRESULT mlpiParameterReadDataArrayLlong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LLONG *data, const ULONG numElements, ULONG *numElementsRet)
This function reads an array of 64-bit signed data values of a parameter.
MLPIRESULT mlpiParameterWriteDataArrayUshort(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const USHORT *data, const ULONG numElements)
This function writes a array of given 16-bit unsigned data values to a parameter. ...
MLPIRESULT mlpiParameterReadDefaultDouble(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, DOUBLE *data)
This function reads the 64-bit floating point default value (double precision) of a parameter...
Procedure command is activated but not yet executed.
wchar_t WCHAR16
UTF16 string.
Definition: mlpiGlobal.h:193
unsigned int ULONG
4 byte unsigned integer
Definition: mlpiGlobal.h:165
MLPIRESULT mlpiParameterReadCommandStatus(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, USHORT *status)
This function reads the parameter command status (comparing to MlpiParameterCommandStatus). Use this function to get the command status of parallel command executions triggered by several calls of mlpiParameterWriteDataUlong or the like.
Error, procedure command execution impossible.
MLPIRESULT mlpiParameterReadDataArrayChar(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, CHAR *data, const ULONG numElements, ULONG *numElementsRet)
This function reads an array of 8-bit signed data values of a parameter.
MLPIRESULT mlpiParameterReadAttribute(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULONG *attribute)
This function reads the attribute of a parameter (Parameter structure, sercos element 3)...
Procedure command has been canceled and is inactive.
MLPIRESULT mlpiParameterReadDefaultLlong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LLONG *data)
This function reads the 64-bit signed default value of a parameter.
MLPIRESULT mlpiParameterWriteDataArrayChar(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const CHAR *data, const ULONG numElements)
This function writes an array of given 8-bit signed data values to a parameter.
MLPIRESULT mlpiParameterWriteAccessSetup(const MLPIHANDLE connection, MlpiParamWriteAccess *writeAccess, const ULONG numElements, PROCESSHANDLE *process)
This function initializes a monitoring of parameters on a write access of the operation data...
MLPIRESULT mlpiParameterReadMaximumDouble(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, DOUBLE *data)
This function reads the 64-bit floating point maximum value (double precision) of a parameter...
MLPIRESULT mlpiParameterReadEverything(const MLPIHANDLE connection, MlpiReadEverything *readEverything, const ULONG numElements, UCHAR *data, const ULONG dataSize)
This function reads every element of a list of given parameters (Parameter structure). This means that you can read multiple parameters at once and you can read each element (value, default value, min, max, attribute, ...) of each parameter at once. All with a single function call instead of multiple calls to different functions. On the server side, the firmware tries to read the data in parallel where possible.
MLPIRESULT mlpiParameterReadMaximumUlong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULONG *data)
This function reads the 32-bit unsigned maximum value of a parameter.
MLPIRESULT mlpiParameterWriteDataArrayUlong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const ULONG *data, const ULONG numElements)
This function writes an array of given 32-bit unsigned data values to a parameter.
MLPIRESULT mlpiParameterReadDefaultShort(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, SHORT *data)
This function reads the 16-bit signed default value of a parameter.
MLPIRESULT mlpiParameterReadDataShort(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, SHORT *data)
This function reads the 16-bit signed data value of a parameter.
MLPIRESULT mlpiParameterExportFile(const MLPIHANDLE connection, const WCHAR16 *path, const WCHAR16 *exportPattern, MlpiSidnError *errorList, const ULONG numElements, ULONG *numElementsRet)
This function exports parameters to a file on CF-card. In String &#39;exportPattern&#39; the instances can be...
MLPIRESULT mlpiParameterReadDataLong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LONG *data)
This function reads the 32-bit signed data value of a parameter.
Error, command status invalid.
MLPIRESULT mlpiParameterReadMinimumUshort(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, USHORT *data)
This function reads the 16-bit unsigned minimum value of a parameter.
MLPIRESULT mlpiParameterWriteAccessAbort(const MLPIHANDLE connection, const PROCESSHANDLE process)
This function aborts a write access monitoring process.
MLPIRESULT mlpiParameterWriteDataArrayShort(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const SHORT *data, const ULONG numElements)
This function writes an array of given 16-bit signed data values to a parameter.
MLPIRESULT mlpiParameterWriteDataUllong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const ULLONG data)
This function writes a given 64-bit unsigned data value to a parameter.
MLPIRESULT mlpiParameterReadDefaultUlong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULONG *data)
This function reads the 32-bit unsigned default value of a parameter.
MLPIRESULT mlpiParameterReadMaximumShort(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, SHORT *data)
This function reads the 16-bit signed maximum value of a parameter.
MLPIRESULT mlpiParameterImportExportGetInfo(const MLPIHANDLE connection, const PROCESSHANDLE process, WCHAR16 *pattern, ULONG numElementsPattern, WCHAR16 *file, ULONG numElementsFile)
This function returns information about a parameter process (import or export).
struct MlpiReadEverything MlpiReadEverything
This structure defines the information returned using mlpiParameterReadEverything.
MLPIRESULT mlpiParameterReadDefaultFloat(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, FLOAT *data)
This function reads the 32-bit floating point default value (single precision) of a parameter...
MLPIRESULT mlpiParameterReadMaximumChar(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, CHAR *data)
This function reads the 8-bit signed maximum value of a parameter.
MLPIRESULT mlpiParameterReadMinimumFloat(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, FLOAT *data)
This function reads the 32-bit floating point minimum value (single precision) of a parameter...
MLPIRESULT mlpiParameterReadMaximumString(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, WCHAR16 *data, const ULONG numElements, ULONG *numElementsRet)
This function reads the maximum value of a parameter and returns it as UTF16 String. A conversion is done automatically.
MLPIRESULT mlpiParameterReadDefaultString(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, WCHAR16 *data, const ULONG numElements, ULONG *numElementsRet)
This function reads the default value of a parameter and returns it as string. A conversion is done a...
MLPIRESULT mlpiParameterReadMaximumLlong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LLONG *data)
This function reads the 64-bit signed maximum value of a parameter.
MLPIRESULT mlpiParameterReadMaximumFloat(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, FLOAT *data)
This function reads the 32-bit floating point maximum value (single precision) of a parameter...
MLPIRESULT mlpiParameterImportExportStatus(const MLPIHANDLE connection, const PROCESSHANDLE process, MlpiParamProcessStatus *status, ULONG *currentCount, ULONG *expectedCount, ULONG *errorsCount, MlpiSidnError *errorList, ULONG numElements)
This function returns the status of a parameter process (import or export).
MLPIRESULT mlpiParameterReadMinimumUllong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULLONG *data)
This function reads the 64-bit unsigned minimum value of a parameter.
long long LLONG
8 byte signed integer
Definition: mlpiGlobal.h:170
MLPIRESULT mlpiParameterReadDataArrayLong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LONG *data, const ULONG numElements, ULONG *numElementsRet)
This function reads an array of 32-bit signed data values of a parameter.
MLPIRESULT mlpiParameterReadDataUshort(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, USHORT *data)
This function reads the 16-bit unsigned data value of a parameter.
float FLOAT
4 byte floating point
Definition: mlpiGlobal.h:172
MLPIRESULT mlpiParameterReadMinimumString(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, WCHAR16 *data, const ULONG numElements, ULONG *numElementsRet)
This function reads the minimum value of a parameter and returns it as String. A conversion is done a...
double DOUBLE
8 byte floating point
Definition: mlpiGlobal.h:177
MLPIRESULT mlpiParameterReadDataArrayUllong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULLONG *data, const ULONG numElements, ULONG *numElementsRet)
This function reads an array of 64-bit unsigned data values of a parameter.
MLPIRESULT mlpiParameterWriteDataArrayVoid(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const void *data, const ULONG dataSize)
This function writes a given data value to a parameter.
MLPIRESULT mlpiParameterReadMaximumUllong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULLONG *data)
This function reads the 64-bit unsigned maximum value of a parameter.
MLPIRESULT mlpiParameterReadListLength(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULONG *numElements, ULONG *numMaxElements, ULONG *elementSize)
This function reads the current and maximum length of a list parameter.
MLPIRESULT mlpiParameterWriteDataLlong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const LLONG data)
This function writes a given 64-bit signed data value to a parameter.
unsigned long MLPIHANDLE
common MLPI-API handle value
Definition: mlpiGlobal.h:206
MLPIRESULT mlpiParameterReadDataArrayUlong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULONG *data, const ULONG numElements, ULONG *numElementsRet)
This function reads an array of 32-bit unsigned data values of a parameter.
MLPIRESULT mlpiParameterImportFileStartProcess(const MLPIHANDLE connection, const WCHAR16 *path, const WCHAR16 *mapping, PROCESSHANDLE *process)
This function imports a parameter file from CF card in a asynchronous way. The string &#39;mapping&#39; can g...
MLPIRESULT mlpiParameterReadDataStatus(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, BOOL8 *status)
This function reads the data status of a parameter.
MLPIRESULT mlpiParameterWriteDataArrayLlong(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const LLONG *data, const ULONG numElements)
This function writes an array of given 64-bit signed data values to a parameter.
Procedure command execution is interrupted.
MLPIRESULT mlpiParameterWriteDataFloat(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const FLOAT data)
This function writes a given 32-bit floating point data value (single precision) to a parameter...
MLPIRESULT mlpiParameterReadDataArrayShort(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, SHORT *data, const ULONG numElements, ULONG *numElementsRet)
This function reads an array of 16-bit signed data values of a parameter.
int MLPIRESULT
common MLPI-API return value
Definition: mlpiGlobal.h:198
MLPIRESULT mlpiParameterReadMaximumUshort(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, USHORT *data)
This function reads the 16-bit unsigned maximum value of a parameter.
MLPIRESULT mlpiParameterReadMaximumUchar(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, UCHAR *data)
This function reads the 8-bit unsigned maximum value of a parameter.
MLPIRESULT mlpiParameterReadDataArrayUshort(const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, USHORT *data, const ULONG numElements, ULONG *numElementsRet)
This function reads an array of 16-bit unsigned data values of a parameter.