mcorest_api_json_write_start

Start writing JSON to a request's response stream.

For an overview see page mcorest_api_json_write_*

Prototype

 
    MCO_RET mcorest_api_json_write_start(mcorest_api_stream_t *s, 
                        mcorest_api_json_write_ctx_t *ctx);
 

Arguments

s The mcorest_api_stream_t to write data to
ctx Pointer to the JSON write context structure

Description

This function starts writing JSON to a request's response stream; opens the top-level JSON object.

Return Codes

MCO_S_OK = 0 Success
MCO_E_REST_* Any of the Web Services Error Codes

Example

 
    static MCO_RET get_stream_print_json_object(mcohs_request_h req)
    {
        mcorest_api_json_write_ctx_t jctx;
        mcorest_api_stream_t jstream;
        ...
         
        mcorest_api_status_ok(req);
        mcorest_api_stream_with_request(req, &jstream);
        mcorest_api_json_write_start(&jstream, &jctx);
        mcorest_api_json_write_key(&jctx, "databases");
        ...
        mcorest_api_json_write_finish(&jctx);
        return MCO_S_OK;
    }
     

Files

Header file:
mcorestapi.h
Source file:
jsonwr.c
Library:
libmcorest.a