1 #ifndef __MLPICONTAINERLIB_H__ 2 #define __MLPICONTAINERLIB_H__ 427 #define MLPI_CONTAINER_TAG_SEPARATOR MLPI_ADAPT_STRING(';') 428 #define MLPI_CONTAINER_ARG_SEPARATOR MLPI_ADAPT_STRING(',') 430 #define MLPI_CONTAINER_TAG_LOGICLIB_MEMORY_AREA MLPI_ADAPT_STRING("LOGICLIB_MEMORY_AREA") 431 #define MLPI_CONTAINER_TAG_LOGICLIB_SYMBOL MLPI_ADAPT_STRING("LOGICLIB_SYMBOL") 432 #define MLPI_CONTAINER_TAG_IOLIB_FIELBUS_IO MLPI_ADAPT_STRING("IOLIB_FIELBUS_IO") //<! Deprecated. 433 #define MLPI_CONTAINER_TAG_IOLIB_FIELDBUS_IO MLPI_ADAPT_STRING("IOLIB_FIELBUS_IO") //<! Spelling of "Fieldbus" was wrong till MLPI version 1.5.0.0. Due to compatibility reasons, we can not change the adapted string value. 434 #define MLPI_CONTAINER_TAG_ALIGNMENT_DUMMY MLPI_ADAPT_STRING("ALIGNMENT_DUMMY") 436 #define MLPI_CONTAINER_ARG_IOLIB_IO_AREA_INPUT MLPI_ADAPT_STRING("INPUT") 437 #define MLPI_CONTAINER_ARG_IOLIB_IO_AREA_OUTPUT MLPI_ADAPT_STRING("OUTPUT") 439 #define MLPI_CONTAINER_ARG_LOGICLIB_MEMORY_AREA_INPUT MLPI_ADAPT_STRING("INPUT") 440 #define MLPI_CONTAINER_ARG_LOGICLIB_MEMORY_AREA_OUTPUT MLPI_ADAPT_STRING("OUTPUT") 441 #define MLPI_CONTAINER_ARG_LOGICLIB_MEMORY_AREA_MARKER MLPI_ADAPT_STRING("MARKER") 443 #define MLPI_CONTAINER_NAME_MAX_LENGTH (64) 458 #if !defined(TARGET_OS_VXWORKS) 494 ULONG numElementsTagList;
516 #if !defined(TARGET_OS_VXWORKS) 532 #if defined(TARGET_OS_WINNT) 533 #if defined(MLPI_EXPORTS) 534 #define MLPI_API __declspec(dllexport) 535 #elif defined(MLPI_IMPORTS) 536 #define MLPI_API __declspec(dllimport) 541 #if defined(MLPI_EXPORTS) 542 #define MLPI_API __attribute__ ((visibility("default"))) 543 #elif defined(MLPI_IMPORTS) 954 #endif // endof: #ifndef __MLPICONTAINERLIB_H__ MLPIRESULT mlpiContainerSetName(const MLPIHANDLE connection, const MlpiContainerHandle handle, const WCHAR16 *name)
Using this function, you can assign a descriptive name to your container. The name can be any string...
MlpiContainerAccess
This enumeration defines whether we have a READ or WRITE container.
struct MlpiContainerInformation MlpiContainerInformation
This structure defines the information content of a container.
MLPIRESULT mlpiContainerGetTagList(const MLPIHANDLE connection, const MlpiContainerHandle handle, WCHAR16 *tagList, const ULONG numElements)
This function returns the tag list of a container. This is the same tagList that was used to create t...
MLPIRESULT mlpiContainerGetSingleItemInformation(const MLPIHANDLE connection, const MlpiContainerHandle handle, const ULONG index, WCHAR16 *tag, const ULONG numElements, MlpiContainerItemInformation *info)
This function returns the item information of a single item in a container. It returns information ab...
MLPIRESULT mlpiContainerCreate(const MLPIHANDLE connection, const WCHAR16 *tagList, const MlpiContainerAccess accessFlag, MlpiContainerHandle *handle, ULONG *dataSize)
This function creates a new container. It has to be specified if the container is a read or write con...
MLPIRESULT mlpiContainerGetItemInformation(const MLPIHANDLE connection, const MlpiContainerHandle handle, MlpiContainerItemInformation *info, const ULONG numElements, ULONG *numElementsRet)
This function returns the item information of a container as an array of struct. Each element in the ...
Enumeration for write container.
wchar_t WCHAR16
UTF16 string.
unsigned int ULONG
4 byte unsigned integer
MLPIRESULT mlpiContainerGetName(const MLPIHANDLE connection, const MlpiContainerHandle handle, WCHAR16 *name, const ULONG numElements)
Using this function, you can read out the name of your container. The name can be any string with a m...
#define MLPI_CONTAINER_NAME_MAX_LENGTH
Maximum length of a container name.
MLPIRESULT mlpiContainerGetInformation(const MLPIHANDLE connection, const MlpiContainerHandle handle, MlpiContainerInformation *info)
Use this function to read various pieces of information about your container. This includes time of c...
MLPIRESULT mlpiContainerDestroy(const MLPIHANDLE connection, MlpiContainerHandle *handle)
This function destroys a container which has been created using mlpiContainerCreate. Containers consume memory resources of the server. You should therefore destroy any containers your application no longer needs!
struct MlpiDateAndTime MlpiDateAndTime
This structure defines the broken date and time information.
MLPIRESULT mlpiContainerGetHandlesOfContainer(const MLPIHANDLE connection, MlpiContainerHandle *handles, const ULONG numElements, ULONG *numElementsRet)
Returns the handles of all containers that were previously created on the device. ...
Enumeration for read container.
MLPIRESULT mlpiContainerGetNumberOfContainer(const MLPIHANDLE connection, ULONG *number)
This function returns the total number of containers created on the device. Also including containers...
MlpiType
This enumeration defines the basic types of as used by the MLPI.
MLPIRESULT mlpiContainerUpdate(const MLPIHANDLE connection, const MlpiContainerHandle handle, void *data, const ULONG dataSize)
This function updates a container. If you pass a handle to a write container, then you also need to p...
struct MlpiContainerItemInformation MlpiContainerItemInformation
This structure defines the information of a container item.
unsigned long MLPIHANDLE
common MLPI-API handle value
struct MlpiContainerHandle MlpiContainerHandle
This structure defines the handle to a container.
int MLPIRESULT
common MLPI-API return value