WebDocs Home | Show Navigation Hide Navigation

Synergy XML API

The Synergy XML API provides direct access to XML from within your Synergy programs.

Understanding the Synergy XML API

%XML_ATTR_COPY – Copy from one XML attribute to another

%XML_ATTR_CREATE – Create an XML attribute

%XML_ATTR_DELETE – Release an XML attribute

%XML_ATTR_GETNAME – Get the name of an XML attribute

%XML_ATTR_GETVALUE – Get the value of an XML attribute

%XML_ATTR_GETVALUEHANDLE – Return the handle for an XML attribute’s value

%XML_ATTR_SETNAME – Set the name of an XML attribute

%XML_ATTR_SETVALUE – Set the value of an XML attribute

%XML_ATTR_SETVALUEHANDLE – Assign a handle as an XML attribute’s value

%XML_ATTRLIST_ADD – Add an attribute to an XML attribute list

%XML_ATTRLIST_ADDLIST – Add a list of attributes to an XML attribute list

%XML_ATTRLIST_CLEAR – Clear XML attribute list contents

%XML_ATTRLIST_COPY – Copy attributes from one XML attribute list to another

%XML_ATTRLIST_COUNT – Count the attributes in an XML attribute list

%XML_ATTRLIST_CREATE – Create an XML attribute list

%XML_ATTRLIST_DELETE – Release an XML attribute list

%XML_ATTRLIST_FIND – Find an attribute in an XML attribute list by name

%XML_ATTRLIST_INSERT – Insert an attribute at a specific position in a list

%XML_ATTRLIST_ITEM – Find an attribute in an XML attribute list by position

%XML_ATTRLIST_REMOVE – Remove an attribute from an XML attribute list

%XML_DOC_ADDDECLARATION – Add a declaration to an XML document

%XML_DOC_CREATE – Create an XML document instance

%XML_DOC_DELETE – Release an XML document instance

%XML_DOC_GETDECLARATION – Get the declaration for an XML document

%XML_DOC_GETROOT – Return the root element of an XML document

%XML_DOC_REMOVEDECLARATION – Remove a declaration from an XML document

%XML_DOC_SETCOMMENT – Set a comment at the XML document level

%XML_DOC_SETDECLARATION – Set the declaration for an XML document

%XML_DOC_SETROOT – Set the root element of an XML document

%XML_DOC_TOFILE – Write contents of an XML document to a file

%XML_DOC_TOSTRING – Write contents of an XML document to an XML string

%XML_ELEM_ADDATTRIBUTES – Add attributes in a list to an XML element

%XML_ELEM_ADDCHILD – Add a child to an XML element

%XML_ELEM_ADDCHILDREN – Add child elements to an XML element

%XML_ELEM_ATTRIBUTES – Return attributes for an XML element

%XML_ELEM_CHILDREN – Get children of an XML element

%XML_ELEM_COPY – Copy from one XML element to another

%XML_ELEM_CREATE – Create an XML element instance

%XML_ELEM_DELETE – Release an XML element instance

%XML_ELEM_GETATTRIBUTE – Get the value of an attribute for an XML element

%XML_ELEM_GETELEMENTSBYNAME – Get children of an XML element by tag

%XML_ELEM_GETNAME – Get the tag name of an XML element

%XML_ELEM_GETTEXT – Get the text value of an XML element

%XML_ELEM_GETTEXTHANDLE – Return handle containing text for an element

%XML_ELEM_REMOVEATTRIBUTE – Remove an attribute from an XML element

%XML_ELEM_REMOVEATTRIBUTES – Remove all attributes from an XML element

%XML_ELEM_REMOVECHILD – Remove the first child specified from an element

%XML_ELEM_REMOVECHILDREN – Remove all child elements from an element

%XML_ELEM_SETATTRIBUTE – Add an attribute to an XML element

%XML_ELEM_SETNAME – Set the tag name of an XML element

%XML_ELEM_SETTEXT – Set the text value of an XML element

%XML_ELEM_SETTEXTHANDLE – Assign a handle as the text for an XML element

%XML_ELEM_TOSTRING – Give the string representation for an XML element

%XML_ELEMLIST_ADD – Add an element to an XML element list

%XML_ELEMLIST_ADDLIST – Add a list of elements to an XML element list

%XML_ELEMLIST_CLEAR – Clear XML element list contents

%XML_ELEMLIST_COPY – Copy an XML element list to another list

%XML_ELEMLIST_COUNT – Count the elements in an XML element list

%XML_ELEMLIST_CREATE – Create an XML element list

%XML_ELEMLIST_DELETE – Release an XML element list

%XML_ELEMLIST_FIND – Find an element in an XML element list by name

%XML_ELEMLIST_FINDTAG – Find an element in an XML element list by tag

%XML_ELEMLIST_INSERT – Insert an XML element at a specific position in a list

%XML_ELEMLIST_ITEM – Find an element in an XML element list by position

%XML_ELEMLIST_REMOVE – Remove an element from an XML element list

%XML_OPTION – Set an XML option value

%XML_PARSER_CREATE – Create an XML parser instance

%XML_PARSER_DELETE – Release an XML parser instance

%XML_PARSER_ERROR – Get the last XML parser error

%XML_PARSER_PARSEFILE – Parse an XML file

%XML_PARSER_PARSESTRING – Parse an XML string

%XML_STRING_APPEND – Append a Synergy alpha string to an XML string

%XML_STRING_APPENDDYN – Append one XML string to another

%XML_STRING_APPENDHANDLE – Append Synergy handle contents to an XML string

%XML_STRING_CLEAR – Clear the contents of an XML string

%XML_STRING_COPY – Copy one XML string to another

%XML_STRING_CREATE – Create an XML string instance

%XML_STRING_DELETE – Release an XML string instance

%XML_STRING_GETHANDLE – Get the memory handle of an XML string

%XML_STRING_GETSIZE – Get the size of an XML string