Creates a new document that must be built in order.
Syntax
SRP_JsonX_BeginString(Name, StartingToken, IsPretty)
Returns
Nothing. SRP_JsonX_BeginString always succeeds, but it can produce a warning if you don't pass "{" or "[" as the starting token. See SRP_JsonX_Error.
Parameters
| Parameter | Description |
|---|---|
| Name | The name of the new document, used for debugging purposes only |
| StartingToken | Determines if the new document's root is an object or an array. Can be "{" or "[". Optional. Default is "{" |
| IsPretty | Set to 1 to make the output human readable, set to 0 to make it compact. Optional. Default is 0 |
Remarks
SRP_JsonX_BeginString creates a new document. If there was already an active document, that one is placed on the stack and this one becomes the active document. New documents must be initialized as a json object or json array, which is done via the StartingToken parameter. Set that parameter to "{" to make the root element an object or "[" to make it an array.
This routine is only for situations where you will be building a json string in order. In fact, SRP_JsonX and SRP_JsonX_End are the only other routines you can use with this kind of document. Each call to SRP_JsonX behaves exactly the same as it always does, but instead of creating json structures in memory, each call appends json text to a string buffer. This is why you must specify the formatting via the IsPretty parameter at the beginning since formatting will be done with each call to SRP_JsonX. When you end the document by calling SRP_JsonX_End, the FormatOptions parameter will be ignored, and the json you built will be returned. If you know you are building json in order, this will be faster than using SRP_JsonX_Begin.
The Name parameter can be anything you want as it is only used for debugging purposes. The name will appear when calling SRP_JsonX_State or SRP_JsonX_Trace.
Note: The IsPretty parameter is just a boolean. Setting it to 1 makes the output pretty, and setting it to 0 makes it concise. If you include the SRPJSONX insert in your code, you may also use JsonxPretty$ or JsonxConcise$ for more code readability.
Examples
$insert SRPJSONX
SRP_JsonX_BeginString('DirectToString', '{', JsonxPretty$)
SRP_JsonX('employees', '[')
SRP_JsonX('{')
SRP_JsonX('firstname', 'John')
SRP_JsonX('lastname', 'Doe')
SRP_JsonX('age', 21)
SRP_JsonX('}')
SRP_JsonX('{')
SRP_JsonX('firstname', 'Anna')
SRP_JsonX('lastname', 'Smith')
SRP_JsonX('age', 32)
SRP_JsonX('}')
SRP_JsonX('{"firstname":"Peter", "lastname":"Jones", "age":43}')
SRP_JsonX(']')
SRP_JsonX('count', 4)
SRP_JsonX('active', 1, 'Bool')
SRP_JsonX('alwaysnull')
SRP_JsonX('alwaysstring', 4.321, 'String')
Json = SRP_JsonX_End()
