There are four steps to calling a compiler-generated C XML decode function:

Before a C JSON decode function can be called; the user must initialize a context variable. This is a variable of type OSCTXT. This variable holds all of the working data used during the decoding of a message. The context variable is declared as a normal automatic variable within the top-level calling function. It must be initialized before use. This can be accomplished by calling the rtxInitContext function:

       OSCTXT ctxt;        // context variable

       stat = rtxInitContext (&ctxt);
       if (0 != stat) {
          printf ("Context initialization failed.\n");
          rtxErrPrint (&ctxt);
          return stat;
       }

The next step is to create a stream object within the context. This object is an abstraction of the input device from which JSON data will be read and parsed. Calling one of the following functions initializes a stream for read operations:

The flags parameter of the rtxStreamSocketAttach function should be set to the OSRTSTRMF_INPUT constant value to indicate an input stream is being created.

A decode function can then be called to decode the message. If the return status indicates success (0), then the message will have been decoded into the given XSD type variable. The decode function may automatically allocate dynamic memory to hold variable length items during the course of decoding. This memory will be tracked in the context structure, so the programmer does not need to worry about freeing it. It will be released when the context is freed.

The final step of the procedure is to close the stream and free the context block. The function to close the stream is rtxStreamClose . The function to free the context is rtxFreeContext.

A program fragment that could be used to decode an employee record is as follows:

   #include employee.h          /* include file generated by XBinder */

   main ()
   {
       int stat;
       OSCTXT ctxt;
       PersonnelRecord employee;
       const char* filename = "message.xml";

       /* Step 1: Init context structure */

       if (rtxInitContext (&ctxt) != 0) return -1;

       Init_PersonnelRecord (&ctxt, &employee);

       /* Step 2: Open a stream */

       stat = rtxStreamFileOpen (&ctxt, filename, OSRTSTRMF_INPUT);
       if (stat != 0) {
            rtxErrPrint (&ctxt);
            return -1;
       }

       /* Step 3: decode the record */

       stat = JsonD_personnelRecord (&ctxt, &employee);
       if (stat == 0) {
            if (trace) {
                 printf ("Decode of PersonnelRecord was successful\n");
                 printf ("Decoded record:\n");
                 Print_PersonnelRecord ("Employee", &employee);
            }
       }
       else {
            printf ("decode of PersonnelRecord failed\n");
            rtxErrPrint (&ctxt);
            rtxStreamClose (&ctxt);
            return -1;
       }

       /* Step 4: Close the stream and free the context. */

       rtxStreamClose (&ctxt);
       rtxFreeContext (&ctxt);

       return 0;
   }