Blame doc/html/json__visit_8h.html

Packit Service def718
Packit Service def718
<html xmlns="http://www.w3.org/1999/xhtml">
Packit Service def718
<head>
Packit Service def718
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
Packit Service def718
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
Packit Service def718
<meta name="generator" content="Doxygen 1.8.8"/>
Packit Service def718
<title>json-c: json_visit.h File Reference</title>
Packit Service def718
<link href="tabs.css" rel="stylesheet" type="text/css"/>
Packit Service def718
<script type="text/javascript" src="jquery.js"></script>
Packit Service def718
<script type="text/javascript" src="dynsections.js"></script>
Packit Service def718
<link href="doxygen.css" rel="stylesheet" type="text/css" />
Packit Service def718
</head>
Packit Service def718
<body>
Packit Service def718
Packit Service def718
Packit Service def718
Packit Service def718
 
Packit Service def718
 
Packit Service def718
  
Packit Service def718
   
json-c
Packit Service def718
    0.13.1
Packit Service def718
   
Packit Service def718
  
Packit Service def718
 
Packit Service def718
 
Packit Service def718
Packit Service def718
Packit Service def718
Packit Service def718
Packit Service def718
  
Packit Service def718
    
    Packit Service def718
          
  • Main Page
  • Packit Service def718
          
  • Related Pages
  • Packit Service def718
          
  • Data Structures
  • Packit Service def718
          
  • Files
  • Packit Service def718
        
    Packit Service def718
      
    Packit Service def718
      
    Packit Service def718
        
      Packit Service def718
            
    • File List
    • Packit Service def718
            
    • Globals
    • Packit Service def718
          
      Packit Service def718
        
      Packit Service def718
      Packit Service def718
      Packit Service def718
        
      Packit Service def718
      Macros |
      Packit Service def718
      Typedefs |
      Packit Service def718
      Functions  
      Packit Service def718
        
      Packit Service def718
      json_visit.h File Reference
      Packit Service def718
      Packit Service def718
      Packit Service def718
      Packit Service def718

      Methods for walking a tree of objects.

      Packit Service def718
      More...

      Packit Service def718
      Packit Service def718

      Packit Service def718
      Macros
      Packit Service def718
      #define JSON_C_VISIT_SECOND   0x02
      Packit Service def718
       
      Packit Service def718
      #define JSON_C_VISIT_RETURN_CONTINUE   0
      Packit Service def718
       
      Packit Service def718
      #define JSON_C_VISIT_RETURN_SKIP   7547
      Packit Service def718
       
      Packit Service def718
      #define JSON_C_VISIT_RETURN_POP   767
      Packit Service def718
       
      Packit Service def718
      #define JSON_C_VISIT_RETURN_STOP   7867
      Packit Service def718
       
      Packit Service def718
      #define JSON_C_VISIT_RETURN_ERROR   -1
      Packit Service def718
       
      Packit Service def718
      Packit Service def718

      Packit Service def718
      Typedefs
      Packit Service def718
      typedef int( json_c_visit_userfunc )(json_object *jso, int flags, json_object *parent_jso, const char *jso_key, size_t *jso_index, void *userarg)
      Packit Service def718
       
      Packit Service def718
      Packit Service def718

      Packit Service def718
      Functions
      Packit Service def718
      int json_c_visit (json_object *jso, int future_flags, json_c_visit_userfunc *userfunc, void *userarg)
      Packit Service def718
       
      Packit Service def718
      Packit Service def718

      Detailed Description

      Packit Service def718

      Methods for walking a tree of objects.

      Packit Service def718

      Macro Definition Documentation

      Packit Service def718
      Packit Service def718
      Packit Service def718
      Packit Service def718
            
      Packit Service def718
              
      Packit Service def718
                #define JSON_C_VISIT_RETURN_CONTINUE   0
      Packit Service def718
              
      Packit Service def718
            
      Packit Service def718
      Packit Service def718

      This json_c_visit_userfunc return value indicates that iteration should proceed normally.

      Packit Service def718
      Packit Service def718
      Packit Service def718
      Packit Service def718
      Packit Service def718
      Packit Service def718
      Packit Service def718
            
      Packit Service def718
              
      Packit Service def718
                #define JSON_C_VISIT_RETURN_ERROR   -1
      Packit Service def718
              
      Packit Service def718
            
      Packit Service def718
      Packit Service def718

      This json_c_visit_userfunc return value indicates that iteration should stop immediately, and cause json_c_visit to return an error.

      Packit Service def718
      Packit Service def718
      Packit Service def718
      Packit Service def718
      Packit Service def718
      Packit Service def718
      Packit Service def718
            
      Packit Service def718
              
      Packit Service def718
                #define JSON_C_VISIT_RETURN_POP   767
      Packit Service def718
              
      Packit Service def718
            
      Packit Service def718
      Packit Service def718

      This json_c_visit_userfunc return value indicates that iteration of the fields/elements of the containing object should stop and continue "popped up" a level of the object hierarchy. For example, returning this when handling arg will result in arg3 and any other fields being skipped. The next call to userfunc will be the JSON_C_VISIT_SECOND call on "foo", followed by a userfunc call on "bar".

      Packit Service def718
      {
      Packit Service def718
        "foo": {
      Packit Service def718
          "arg1": 1,
      Packit Service def718
          "arg2": 2,
      Packit Service def718
          "arg3": 3,
      Packit Service def718
          ...
      Packit Service def718
        },
      Packit Service def718
        "bar": {
      Packit Service def718
          ...
      Packit Service def718
        }
      Packit Service def718
      }
      Packit Service def718
       
      Packit Service def718
      Packit Service def718
      Packit Service def718
      Packit Service def718
      Packit Service def718
      Packit Service def718
            
      Packit Service def718
              
      Packit Service def718
                #define JSON_C_VISIT_RETURN_SKIP   7547
      Packit Service def718
              
      Packit Service def718
            
      Packit Service def718
      Packit Service def718

      This json_c_visit_userfunc return value indicates that iteration over the members of the current object should be skipped. If the current object isn't a container (array or object), this is no different than JSON_C_VISIT_RETURN_CONTINUE.

      Packit Service def718
      Packit Service def718
      Packit Service def718
      Packit Service def718
      Packit Service def718
      Packit Service def718
      Packit Service def718
            
      Packit Service def718
              
      Packit Service def718
                #define JSON_C_VISIT_RETURN_STOP   7867
      Packit Service def718
              
      Packit Service def718
            
      Packit Service def718
      Packit Service def718

      This json_c_visit_userfunc return value indicates that iteration should stop immediately, and cause json_c_visit to return success.

      Packit Service def718
      Packit Service def718
      Packit Service def718
      Packit Service def718
      Packit Service def718
      Packit Service def718
      Packit Service def718
            
      Packit Service def718
              
      Packit Service def718
                #define JSON_C_VISIT_SECOND   0x02
      Packit Service def718
              
      Packit Service def718
            
      Packit Service def718
      Packit Service def718

      Passed to json_c_visit_userfunc as one of the flags values to indicate that this is the second time a container (array or object) is being called, after all of it's members have been iterated over.

      Packit Service def718
      Packit Service def718
      Packit Service def718
      Packit Service def718

      Typedef Documentation

      Packit Service def718
      Packit Service def718
      Packit Service def718
      Packit Service def718
            
      Packit Service def718
              
      Packit Service def718
                typedef int( json_c_visit_userfunc)(json_object *jso, int flags, json_object *parent_jso, const char *jso_key, size_t *jso_index, void *userarg)
      Packit Service def718
              
      Packit Service def718
            
      Packit Service def718
      Packit Service def718
      Packit Service def718
      Packit Service def718
      Packit Service def718

      Function Documentation

      Packit Service def718
      Packit Service def718
      Packit Service def718
      Packit Service def718
            
      Packit Service def718
              
      Packit Service def718
                int json_c_visit 
      Packit Service def718
                (
      Packit Service def718
                json_object
      Packit Service def718
                jso, 
      Packit Service def718
              
      Packit Service def718
              
      Packit Service def718
                
      Packit Service def718
                
      Packit Service def718
                int 
      Packit Service def718
                future_flags, 
      Packit Service def718
              
      Packit Service def718
              
      Packit Service def718
                
      Packit Service def718
                
      Packit Service def718
                json_c_visit_userfunc
      Packit Service def718
                userfunc, 
      Packit Service def718
              
      Packit Service def718
              
      Packit Service def718
                
      Packit Service def718
                
      Packit Service def718
                void * 
      Packit Service def718
                userarg 
      Packit Service def718
              
      Packit Service def718
              
      Packit Service def718
                
      Packit Service def718
                )
      Packit Service def718
                
      Packit Service def718
              
      Packit Service def718
            
      Packit Service def718
      Packit Service def718

      Visit each object in the JSON hierarchy starting at jso. For each object, userfunc is called, passing the object and userarg. If the object has a parent (i.e. anything other than jso itself) its parent will be passed as parent_jso, and either jso_key or jso_index will be set, depending on whether the parent is an object or an array.

      Packit Service def718

      Nodes will be visited depth first, but containers (arrays and objects) will be visited twice, the second time with JSON_C_VISIT_SECOND set in flags.

      Packit Service def718

      userfunc must return one of the defined return values, to indicate whether and how to continue visiting nodes, or one of various ways to stop.

      Packit Service def718

      Returns 0 if nodes were visited successfully, even if some were intentionally skipped due to what userfunc returned. Returns <0 if an error occurred during iteration, including if userfunc returned JSON_C_VISIT_RETURN_ERROR.

      Packit Service def718
      Packit Service def718
      Packit Service def718
      Packit Service def718
      Packit Service def718
      Packit Service def718

      <address class="footer"><small>
      Packit Service def718
      Generated on Mon Mar 5 2018 23:17:09 for json-c by  
      Packit Service def718
      doxygen
      Packit Service def718
       1.8.8
      Packit Service def718
      </small></address>
      Packit Service def718
      </body>
      Packit Service def718
      </html>