Generated from xmlrpc.h with ROBODoc v3.2.3 on Sat Sep 29 15:45:37 2001

TABLE OF CONTENTS

  1. VALUE/XMLRPC_CASE
  2. VALUE/XMLRPC_CASE_COMPARISON
  3. VALUE/XMLRPC_Callback
  4. VALUE/XMLRPC_ERROR
  5. VALUE/XMLRPC_ERROR_CODE
  6. VALUE/XMLRPC_MACROS
  7. VALUE/XMLRPC_REQUEST_INPUT_OPTIONS
  8. VALUE/XMLRPC_REQUEST_OUTPUT_OPTIONS
  9. VALUE/XMLRPC_REQUEST_TYPE
  10. VALUE/XMLRPC_VALUE_TYPE
  11. VALUE/XMLRPC_VALUE_TYPE_EASY
  12. VALUE/XMLRPC_VECTOR_TYPE
  13. VALUE/XMLRPC_VERSION

VALUE/XMLRPC_CASE

NAME
   XMLRPC_CASE
NOTES
   Defines case behavior when setting IDs in XMLRPC_VALUE API's
SEE ALSO
   XMLRPC_CASE_COMPARISON
   XMLRPC_VALUE
SOURCE
    typedef enum _xmlrpc_case {
       xmlrpc_case_exact,            /* leave case alone             */
       xmlrpc_case_lower,            /* lower-case id                */
       xmlrpc_case_upper             /* upper-case id                */
    } XMLRPC_CASE;

VALUE/XMLRPC_CASE_COMPARISON

NAME
   XMLRPC_CASE_COMPARISON
NOTES
   Defines case comparison options for XMLRPC_VALUE/VECTOR API's
SEE ALSO
   XMLRPC_CASE
   XMLRPC_VALUE
SOURCE
    typedef enum _xmlrpc_case_comparison {
       xmlrpc_case_insensitive,      /* use case-insensitive compare */
       xmlrpc_case_sensitive         /* use case-sensitive compare   */
    } XMLRPC_CASE_COMPARISON;

VALUE/XMLRPC_Callback

NAME
   XMLRPC_Callback
NOTES
   Function prototype for user defined method handlers (callbacks).
SEE ALSO
   XMLRPC_ServerRegisterMethod ()
   XMLRPC_ServerCallMethod ()
   XMLRPC_REQUEST
   XMLRPC_VALUE
SOURCE
    typedef XMLRPC_VALUE (*XMLRPC_Callback)(XMLRPC_SERVER server, XMLRPC_REQUEST input, void* userData);

VALUE/XMLRPC_ERROR

NAME
   XMLRPC_ERROR
NOTES
   For the reporting and handling of errors
SOURCE
    typedef struct _xmlrpc_error {
       XMLRPC_ERROR_CODE      code;
       STRUCT_XML_ELEM_ERROR  xml_elem_error;  /* xml_element errors (parser errors) */
    } STRUCT_XMLRPC_ERROR, *XMLRPC_ERROR;

VALUE/XMLRPC_ERROR_CODE

NAME
   XMLRPC_ERROR_CODE
NOTES
   All existing error codes
SEE ALSO
   XMLRPC_REQUEST_ERROR
SOURCE
    typedef enum _xmlrpc_error_code {
       xmlrpc_error_none                      = 0,              /* not an error                                      */
       xmlrpc_error_parse_xml_syntax          = -32700,
       xmlrpc_error_parse_unknown_encoding    = -32701,
       xmlrpc_error_parse_bad_encoding        = -32702,
       xmlrpc_error_invalid_xmlrpc            = -32600,
       xmlrpc_error_unknown_method            = -32601,
       xmlrpc_error_invalid_params            = -32602,
       xmlrpc_error_internal_server           = -32603,
       xmlrpc_error_application               = -32500,
       xmlrpc_error_system                    = -32400,
       xmlrpc_error_transport                 = -32300
    } XMLRPC_ERROR_CODE;

VALUE/XMLRPC_MACROS

NAME
   Some Helpful Macros
NOTES
   Some macros for making life easier.  Should be self-explanatory.
SEE ALSO
   XMLRPC_AddValueToVector ()
   XMLRPC_VectorGetValueWithID_Case ()
   XMLRPC_VALUE
SOURCE
    /* Append values to vector */
    #define XMLRPC_VectorAppendString(vector, id, s, len) XMLRPC_AddValueToVector(vector, XMLRPC_CreateValueString(id, s, len))
    #define XMLRPC_VectorAppendBase64(vector, id, s, len) XMLRPC_AddValueToVector(vector, XMLRPC_CreateValueBase64(id, s, len))
    #define XMLRPC_VectorAppendDateTime(vector, id, time) XMLRPC_AddValueToVector(vector, XMLRPC_CreateValueDateTime(id, time))
    #define XMLRPC_VectorAppendDateTime_ISO8601(vector, id, s) XMLRPC_AddValueToVector(vector, XMLRPC_CreateValueDateTime_ISO8601(id, s))
    #define XMLRPC_VectorAppendDouble(vector, id, f) XMLRPC_AddValueToVector(vector, XMLRPC_CreateValueDouble(id, f))
    #define XMLRPC_VectorAppendInt(vector, id, i) XMLRPC_AddValueToVector(vector, XMLRPC_CreateValueInt(id, i))
    #define XMLRPC_VectorAppendBoolean(vector, id, i) XMLRPC_AddValueToVector(vector, XMLRPC_CreateValueBoolean(id, i))
    
    /* Get named values from vector */
    #define XMLRPC_VectorGetValueWithID(vector, id) XMLRPC_VectorGetValueWithID_Case(vector, id, XMLRPC_DEFAULT_ID_CASE_SENSITIVITY)
    #define XMLRPC_VectorGetStringWithID(vector, id) XMLRPC_GetValueString(XMLRPC_VectorGetValueWithID(vector, id))
    #define XMLRPC_VectorGetBase64WithID(vector, id) XMLRPC_GetValueBase64(XMLRPC_VectorGetValueWithID(vector, id))
    #define XMLRPC_VectorGetDateTimeWithID(vector, id) XMLRPC_GetValueDateTime(XMLRPC_VectorGetValueWithID(vector, id))
    #define XMLRPC_VectorGetDoubleWithID(vector, id) XMLRPC_GetValueDouble(XMLRPC_VectorGetValueWithID(vector, id))
    #define XMLRPC_VectorGetIntWithID(vector, id) XMLRPC_GetValueInt(XMLRPC_VectorGetValueWithID(vector, id))
    #define XMLRPC_VectorGetBooleanWithID(vector, id) XMLRPC_GetValueBoolean(XMLRPC_VectorGetValueWithID(vector, id))    

VALUE/XMLRPC_REQUEST_INPUT_OPTIONS

NAME
   XMLRPC_REQUEST_INPUT_OPTIONS
NOTES
   Defines options for reading in xml data
SEE ALSO
   XMLRPC_VERSION
   XML_ELEM_INPUT_OPTIONS
   XMLRPC_REQUEST_From_XML ()
SOURCE
    typedef struct _xmlrpc_request_input_options {
       STRUCT_XML_ELEM_INPUT_OPTIONS  xml_elem_opts;  /* xml_element specific output options */
    } STRUCT_XMLRPC_REQUEST_INPUT_OPTIONS, *XMLRPC_REQUEST_INPUT_OPTIONS;

VALUE/XMLRPC_REQUEST_OUTPUT_OPTIONS

NAME
   XMLRPC_REQUEST_OUTPUT_OPTIONS
NOTES
   Defines output options for generated xml
SEE ALSO
   XMLRPC_VERSION
   XML_ELEM_OUTPUT_OPTIONS
   XMLRPC_REQUEST_To_XML ()
SOURCE
    typedef struct _xmlrpc_request_output_options {
       STRUCT_XML_ELEM_OUTPUT_OPTIONS xml_elem_opts;  /* xml_element specific output options */
       XMLRPC_VERSION                 version;        /* xml vocabulary to use               */
    } STRUCT_XMLRPC_REQUEST_OUTPUT_OPTIONS, *XMLRPC_REQUEST_OUTPUT_OPTIONS;

VALUE/XMLRPC_REQUEST_TYPE

NAME
   XMLRPC_REQUEST_TYPE
NOTES
   Defines data types for XMLRPC_REQUEST
SEE ALSO
   XMLRPC_VALUE_TYPE
   XMLRPC_VECTOR_TYPE
SOURCE
    typedef enum _xmlrpc_request_type {
       xmlrpc_request_none,          /* not a valid request            */
       xmlrpc_request_call,          /* calling/invoking a method      */
       xmlrpc_request_response,      /* responding to a method call    */
    } XMLRPC_REQUEST_TYPE;

VALUE/XMLRPC_VALUE_TYPE

NAME
   XMLRPC_VALUE_TYPE
NOTES
   Defines data types for XMLRPC_VALUE
   Deprecated for public use.  See XMLRPC_VALUE_TYPE_EASY
SEE ALSO
   XMLRPC_VECTOR_TYPE
   XMLRPC_REQUEST_TYPE
SOURCE
    typedef enum _XMLRPC_VALUE_TYPE {
       xmlrpc_none,                   /* not a value                    */
       xmlrpc_empty,                  /* empty value, eg NULL           */
       xmlrpc_base64,                 /* base64 value, eg binary data   */
       xmlrpc_boolean,                /* boolean  [0 | 1]               */
       xmlrpc_datetime,               /* datetime [ISO8601 | time_t]    */
       xmlrpc_double,                 /* double / floating point        */
       xmlrpc_int,                    /* integer                        */
       xmlrpc_string,                 /* string                         */
       xmlrpc_vector                  /* vector, aka list, array        */
    } XMLRPC_VALUE_TYPE;

VALUE/XMLRPC_VALUE_TYPE_EASY

NAME
   XMLRPC_VALUE_TYPE_EASY
NOTES
   Defines data types for XMLRPC_VALUE, including vector types.
SEE ALSO
   XMLRPC_VECTOR_TYPE
   XMLRPC_REQUEST_TYPE
SOURCE
    typedef enum _XMLRPC_VALUE_TYPE_EASY {
       xmlrpc_type_none,               /* not a value                    */
       xmlrpc_type_empty,              /* empty value, eg NULL           */
       xmlrpc_type_base64,             /* base64 value, eg binary data   */
       xmlrpc_type_boolean,            /* boolean  [0 | 1]               */
       xmlrpc_type_datetime,           /* datetime [ISO8601 | time_t]    */
       xmlrpc_type_double,             /* double / floating point        */
       xmlrpc_type_int,                /* integer                        */
       xmlrpc_type_string,             /* string                         */
    /* -- IMPORTANT: identical to XMLRPC_VALUE_TYPE to this point. --   */
            xmlrpc_type_array,              /* vector array                   */
            xmlrpc_type_mixed,              /* vector mixed                   */
            xmlrpc_type_struct              /* vector struct                  */
    } XMLRPC_VALUE_TYPE_EASY;

VALUE/XMLRPC_VECTOR_TYPE

NAME
   XMLRPC_VECTOR_TYPE
NOTES
   Defines data types for XMLRPC_VECTOR.
   Deprecated for public use.  See XMLRPC_VALUE_TYPE_EASY
SEE ALSO
   XMLRPC_VALUE_TYPE
   XMLRPC_REQUEST_TYPE
SOURCE
    typedef enum _XMLRPC_VECTOR_TYPE {
       xmlrpc_vector_none,            /* not an array                   */
       xmlrpc_vector_array,           /* no values may have key names   */
       xmlrpc_vector_mixed,           /* some values may have key names */
       xmlrpc_vector_struct           /* all values must have key names */
    } XMLRPC_VECTOR_TYPE;

VALUE/XMLRPC_VERSION

NAME
   XMLRPC_VERSION
NOTES
   Defines xml vocabulary used for generated xml
SEE ALSO
   XMLRPC_REQUEST_OUTPUT_OPTIONS
   XMLRPC_REQUEST_To_XML ()
SOURCE
    typedef enum _xmlrpc_version {
       xmlrpc_version_none,          /* not a recognized vocabulary    */ 
       xmlrpc_version_1_0,           /* xmlrpc 1.0 standard vocab      */ 
       xmlrpc_version_simple = 2,    /* alt more readable vocab        */ 
       xmlrpc_version_danda = 2,     /* same as simple. legacy         */
            xmlrpc_version_soap_1_1 = 3     /* SOAP. version 1.1              */
    } XMLRPC_VERSION;