CmpXMLParser Library Documentation ¶ Company System Title CmpXMLParser Version 3.5.17.0 Categories System|SysLibs Author 3S - Smart Software Solutions GmbH Placeholder CmpXMLParser Description 1 ¶ This library provides access to the XML parser component in the runtime system. Contents: ¶ ComponentID (GVL) CreateXMLParser2 (Function) Encoding (GVL) EventIDs (GVL) EventParameter EVTPARAM_CmpXMLData (Struct) EVTPARAM_CmpXMLEnd (Struct) EVTPARAM_CmpXMLStart (Struct) FreeXMLParser (Function) ParseXML2 (Function) XMLFLags (GVL) Indices and tables ¶ 1 Based on CmpXMLParser.library, last modified 20.04.2021, 16:00:18. LibDoc 4.4.0.0-b.27 The content file CmpXMLParser.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 20.04.2021, 16:00:18.
ComponentID (GVL) ¶ InOut: Scope Name Type Initial Comment Constant CMPID_CmpXMLParser DWORD 16#58 ComponentID to specify for EventOpen
CreateXMLParser2 (FUN) ¶ FUNCTION CreateXMLParser2 : RTS_IEC_HANDLE InOut: Scope Name Type Return CreateXMLParser2 RTS_IEC_HANDLE Input szXMLFileName STRING szEncoding STRING Inout Result RTS_IEC_RESULT
Encoding (GVL) ¶ InOut: Scope Name Type Initial Constant RTS_XML_ENCODING_UTF8 STRING ‘UTF-8’ RTS_XML_ENCODING_UTF16 STRING ‘UTF-16’
EventIDs (GVL) ¶ InOut: Scope Name Type Initial Comment Constant EVTPARAMID_CmpXMLStart WORD 16#1 IDs for the event parameter structures EVTVERSION_CmpXMLStart WORD 16#1 EVT_XMLStart DWORD 16#10001 <category>Events</category> <description>Event is sent, if a new XML tag is detected</description> <param name=”pEventParam” type=”IN”>EVTPARAM_CmpXMLStart</param> EVTPARAMID_CmpXMLData WORD 16#2 IDs for the event parameter structures EVTVERSION_CmpXMLData WORD 16#1 EVT_XMLData DWORD 16#10002 <category>Events</category> <description>Event is sent, if the end of a XML tag is detected</description> <param name=”pEventParam” type=”IN”>EVTPARAM_CmpXMLEnd</param> EVTPARAMID_CmpXMLEnd WORD 16#3 IDs for the event parameter structures EVTVERSION_CmpXMLEnd WORD 16#1 EVT_XMLEnd DWORD 16#10003 <category>Events</category> <description>Event is sent, if the end of a XML tag is detected</description> <param name=”pEventParam” type=”IN”>EVTPARAM_CmpXMLEnd</param>
EventParameter ¶ EVTPARAM_CmpXMLData (Struct) EVTPARAM_CmpXMLEnd (Struct) EVTPARAM_CmpXMLStart (Struct)
EVTPARAM_CmpXMLData (STRUCT) ¶ TYPE EVTPARAM_CmpXMLData : STRUCT <category>Event parameter</category> <element name=”hXML” type=”IN”>Handle to XML parser</element> <element name=”ulFlags” type=”IN”>Flags. See corresponding category</element> <element name=”pUserData” type=”IN”>Pointer to user data</element> <element name=”pcwName” type=”IN”>Pointer to tag name</element> <element name=”ppcwAttributes” type=”IN”>Pointer to list of attributes (NULL terminated list)</element> InOut: Name Type hXMLParser RTS_IEC_HANDLE ulFlags UDINT pUserData POINTER TO BYTE pcwValue POINTER TO RTS_IEC_CWCHAR nValueLen DINT
EVTPARAM_CmpXMLEnd (STRUCT) ¶ TYPE EVTPARAM_CmpXMLEnd : STRUCT <category>Event parameter</category> <element name=”hXML” type=”IN”>Handle to XML parser</element> <element name=”ulFlags” type=”IN”>Flags. See corresponding category</element> <element name=”pUserData” type=”IN”>Pointer to user data</element> <element name=”pcwName” type=”IN”>Pointer to tag name</element> InOut: Name Type hXMLParser RTS_IEC_HANDLE ulFlags UDINT pUserData POINTER TO BYTE pcwName POINTER TO RTS_IEC_CWCHAR
EVTPARAM_CmpXMLStart (STRUCT) ¶ TYPE EVTPARAM_CmpXMLStart : STRUCT <category>Event parameter</category> <element name=”hXML” type=”IN”>Handle to XML parser</element> <element name=”ulFlags” type=”IN”>Flags. See corresponding category</element> <element name=”pUserData” type=”IN”>Pointer to user data</element> <element name=”pcwName” type=”IN”>Pointer to tag name</element> InOut: Name Type hXMLParser RTS_IEC_HANDLE ulFlags UDINT pUserData POINTER TO BYTE pcwName POINTER TO RTS_IEC_CWCHAR ppcwAttributes POINTER TO POINTER TO RTS_IEC_CWCHAR
FreeXMLParser (FUN) ¶ FUNCTION FreeXMLParser : RTS_IEC_RESULT InOut: Scope Name Type Return FreeXMLParser RTS_IEC_RESULT Input hParser RTS_IEC_HANDLE
