Jump to content

Component: XML JSON Parser (Runtime Tools)

From Flowcode Help
Revision as of 14:14, 20 January 2023 by Wiki bot (talk | contribs)
Author MatrixTSL
Version 1.0
Category Runtime Tools


XML JSON Parser component

A component designed to simplify the collection of data from XML and JSON sources. Parses the raw data and creates a dynamic representation of the data that is easy to navigate and interrogate. Also allows the objects to be manually created or edited and then re-exported as XML or JSON format.

Component Source Code

Please click here for the component source code: FC_Comp_Source_XMLParser.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

SetObjectString
Sets the data string of an existing object. 
- HANDLE Object
Handle to the object 
- STRING Data
 
- VOID Return


GetRootHandle
Allows for user to step through the objects manually using the inbuilt runtime api calls. 
- HANDLE Return


FindObject
Finds the first instance of an object. Returns the first matching path from the root. Returns 0 if the path was not found. 
- STRING ObjPath
e.g. "rss.channel.title" 
- HANDLE Return


FindObjectString
Searches for and then collects the data string from the specified path. Returns the first matching path from the root. 
- STRING ObjPath
e.g. "rss.channel.title" 
- STRING Return


AddObject
Adds a tag at the selected location. Use the GetRootHandle and runtime API Tree functions . Returns the handle of the new object. 
- HANDLE ParentObject
The Object Handle to store the new tag inside 
- STRING Tag
Name of the object 
- STRING Data
data for the object (optional) 
- HANDLE Return


FindNextObject
Finds the next instance of an object following a GetObject* call. Returns the first matching path from the last search. Returns 0 if the path was not found. 
- STRING SubObjPath
e.g. "item.title" 
- HANDLE Return


ParseJSONDataString
Parses JSON formatted data in a piecemeal format as and when file data is available. Creates objects to store the contents of the JSON  
- STRING Data
JSON Data string, can be a chunk of a file at a time 
- UINT Length
Number of Bytes to process 
- VOID Return


GetObjectString
Collects the data string from the specified object. 
- HANDLE Object
Handle to the object 
- STRING Return


ClearObjects
Deletes all object data ready for fresh input 
- VOID Return


GetObjectTag
Collects the tag string from the specified object. 
- HANDLE Object
Handle to the object 
- STRING Return


BuildXMLString
Generate a XML string based on the current objects inside the component. 
- STRING Return


DeleteObject
Deletes a selected tag object. 
- HANDLE Object
Handle to the object 
- BOOL Return


FindNextObjectString
Searches for and then collects the data string from the specified path. Returns the first matching path from the last search 
- STRING SubObjPath
e.g. "item.title" 
- STRING Return


BuildJSONString
Generate a JSON string based on the current objects inside the component. 
- STRING Return


SetObjectTag
Sets the tag name of an existing object. 
- HANDLE Object
Handle to the object 
- STRING Tag
 
- VOID Return


ParseXMLDataString
Parses XML formatted data in a piecemeal format as and when file data is available. Creates objects to store the contents of the XML. 
- STRING Data
XML Data string, can be a chunk of a file at a time 
- UINT Length
Number of bytes to process 
- VOID Return



Property reference

Properties