You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Current »

Creates a new document.

Syntax

SRP_JsonX_Begin(Name, StartingToken)

Returns

Nothing. SRP_JsonX_Begin always succeeds, but it can produce a warning if you don't pass "{" or "[" as the starting token. See SRP_JsonX_Error.

Parameters

ParameterDescription
NameThe name of the new document, used for debugging purposes only
StartingTokenDetermines if the new document's root is an object or an array. Can be "{" or "[". Optional. Default is "{"

Remarks

SRP_JsonX_Begin 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.

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.

Every call to SRP_JsonX_Begin must eventually be paired with a call to SRP_JsonX_End.

Examples

$insert SRPJSONX

SRP_JsonX_Begin('MyDocument', '{')
    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('Pretty')
  • No labels