# PXMLRPCBlock Class Reference

`#include <pxmlrpc.h>`

Inheritance diagram for PXMLRPCBlock:

List of all members.

## Public Member Functions

| PXMLRPCBlock ()
| PXMLRPCBlock (const PString &method)
| PXMLRPCBlock (const PString &method, const PXMLRPCStructBase &structData)
PBoolean | Load (const PString &str)
PXMLElement * | GetParams ()
PXMLElement * | GetParam (PINDEX idx) const
PINDEX | GetParamCount () const
PINDEX | GetFaultCode () const
PString | GetFaultText () const
void | SetFault (PINDEX code, const PString &text)
PBoolean | ValidateResponse ()
PBoolean | GetParams (PXMLRPCStructBase &data)
PBoolean | GetParam (PINDEX idx, PString &type, PString &result)
PBoolean | GetExpectedParam (PINDEX idx, const PString &expectedType, PString &value)
PBoolean | GetParam (PINDEX idx, PString &result)
PBoolean | GetParam (PINDEX idx, int &result)
PBoolean | GetParam (PINDEX idx, double &result)
PBoolean | GetParam (PINDEX idx, PTime &result, int tz=PTime::GMT)
PBoolean | GetParam (PINDEX idx, PStringToString &result)
PBoolean | GetParam (PINDEX idx, PXMLRPCStructBase &result)
PBoolean | GetParam (PINDEX idx, PStringArray &result)
PBoolean | GetParam (PINDEX idx, PArray< PStringToString > &result)
PBoolean | ParseScalar (PXMLElement *element, PString &type, PString &value)
PBoolean | ParseStruct (PXMLElement *element, PStringToString &structDict)
PBoolean | ParseStruct (PXMLElement *element, PXMLRPCStructBase &structData)
PBoolean | ParseArray (PXMLElement *element, PStringArray &array)
PBoolean | ParseArray (PXMLElement *element, PArray< PStringToString > &array)
PBoolean | ParseArray (PXMLElement *element, PXMLRPCVariableBase &array)
void | AddParam (PXMLElement *parm)
void | AddParam (const PString &str)
void | AddParam (int value)
void | AddParam (double value)
void | AddParam (const PTime &time)
void | AddParam (const PXMLRPCStructBase &structData)
void | AddBinary (const PBYTEArray &data)
void | AddStruct (const PStringToString &dict)
void | AddStruct (const PStringToString &dict, const PString &typeStr)
void | AddArray (const PStringArray &array)
void | AddArray (const PStringArray &array, const PString &typeStr)
void | AddArray (const PStringArray &array, const PStringArray &types)
void | AddArray (const PArray< PStringToString > &array)

## Static Public Member Functions

static PXMLElement * | CreateValueElement (PXMLElement *element)
static PXMLElement * | CreateScalar (const PString &type, const PString &scalar)
static PXMLElement * | CreateMember (const PString &name, PXMLElement *value)
static PXMLElement * | CreateScalar (const PString &str)
static PXMLElement * | CreateScalar (int value)
static PXMLElement * | CreateScalar (double value)
static PXMLElement * | CreateDateAndTime (const PTime &time)
static PXMLElement * | CreateBinary (const PBYTEArray &data)
static PXMLElement * | CreateStruct ()
static PXMLElement * | CreateStruct (const PStringToString &dict)
static PXMLElement * | CreateStruct (const PStringToString &dict, const PString &typeStr)
static PXMLElement * | CreateStruct (const PXMLRPCStructBase &structData)
static PXMLElement * | CreateArray (const PStringArray &array)
static PXMLElement * | CreateArray (const PStringArray &array, const PString &typeStr)
static PXMLElement * | CreateArray (const PStringArray &array, const PStringArray &types)
static PXMLElement * | CreateArray (const PArray< PStringToString > &array)
static PXMLElement * | CreateArray (const PXMLRPCVariableBase &array)

## Protected Attributes

PXMLElement * | params
PString | faultText
PINDEX | faultCode

## Constructor & Destructor Documentation

PXMLRPCBlock::PXMLRPCBlock | ( |  | ) |

PXMLRPCBlock::PXMLRPCBlock | ( | const PString & | method | ) |

PXMLRPCBlock::PXMLRPCBlock | ( | const PString & | method,
|  | const PXMLRPCStructBase & | structData |
| ) |  |  |

## Member Function Documentation

void PXMLRPCBlock::AddArray | ( | const PArray< PStringToString > & | array | ) |

void PXMLRPCBlock::AddArray | ( | const PStringArray & | array,
|  | const PStringArray & | types |
| ) |  |  |

void PXMLRPCBlock::AddArray | ( | const PStringArray & | array,
|  | const PString & | typeStr |
| ) |  |  |

void PXMLRPCBlock::AddArray | ( | const PStringArray & | array | ) |

void PXMLRPCBlock::AddBinary | ( | const PBYTEArray & | data | ) |

void PXMLRPCBlock::AddParam | ( | const PXMLRPCStructBase & | structData | ) |

void PXMLRPCBlock::AddParam | ( | const PTime & | time | ) |

void PXMLRPCBlock::AddParam | ( | double | value | ) |

void PXMLRPCBlock::AddParam | ( | int | value | ) |

void PXMLRPCBlock::AddParam | ( | const PString & | str | ) |

void PXMLRPCBlock::AddParam | ( | PXMLElement * | parm | ) |

void PXMLRPCBlock::AddStruct | ( | const PStringToString & | dict,
|  | const PString & | typeStr |
| ) |  |  |

void PXMLRPCBlock::AddStruct | ( | const PStringToString & | dict | ) |

static PXMLElement* PXMLRPCBlock::CreateArray | ( | const PXMLRPCVariableBase & | array | ) | `[static]`

static PXMLElement* PXMLRPCBlock::CreateArray | ( | const PArray< PStringToString > & | array | ) | `[static]`

static PXMLElement* PXMLRPCBlock::CreateArray | ( | const PStringArray & | array,
|  | const PStringArray & | types |
| ) |  |  | `[static]`

static PXMLElement* PXMLRPCBlock::CreateArray | ( | const PStringArray & | array,
|  | const PString & | typeStr |
| ) |  |  | `[static]`

static PXMLElement* PXMLRPCBlock::CreateArray | ( | const PStringArray & | array | ) | `[static]`

static PXMLElement* PXMLRPCBlock::CreateBinary | ( | const PBYTEArray & | data | ) | `[static]`

static PXMLElement* PXMLRPCBlock::CreateDateAndTime | ( | const PTime & | time | ) | `[static]`

static PXMLElement* PXMLRPCBlock::CreateMember | ( | const PString & | name,
|  | PXMLElement * | value |
| ) |  |  | `[static]`

static PXMLElement* PXMLRPCBlock::CreateScalar | ( | double | value | ) | `[static]`

static PXMLElement* PXMLRPCBlock::CreateScalar | ( | int | value | ) | `[static]`

static PXMLElement* PXMLRPCBlock::CreateScalar | ( | const PString & | str | ) | `[static]`

static PXMLElement* PXMLRPCBlock::CreateScalar | ( | const PString & | type,
|  | const PString & | scalar |
| ) |  |  | `[static]`

static PXMLElement* PXMLRPCBlock::CreateStruct | ( | const PXMLRPCStructBase & | structData | ) | `[static]`

static PXMLElement* PXMLRPCBlock::CreateStruct | ( | const PStringToString & | dict,
|  | const PString & | typeStr |
| ) |  |  | `[static]`

static PXMLElement* PXMLRPCBlock::CreateStruct | ( | const PStringToString & | dict | ) | `[static]`

static PXMLElement* PXMLRPCBlock::CreateStruct | ( |  | ) | `[static]`

static PXMLElement* PXMLRPCBlock::CreateValueElement | ( | PXMLElement * | element | ) | `[static]`

PBoolean PXMLRPCBlock::GetExpectedParam | ( | PINDEX | idx,
|  | const PString & | expectedType,
|  | PString & | value |
| ) |  |  |

PINDEX PXMLRPCBlock::GetFaultCode | ( |  | ) | const`[inline]`

PString PXMLRPCBlock::GetFaultText | ( |  | ) | const`[inline]`

PBoolean PXMLRPCBlock::GetParam | ( | PINDEX | idx,
|  | PArray< PStringToString > & | result |
| ) |  |  |

PBoolean PXMLRPCBlock::GetParam | ( | PINDEX | idx,
|  | PStringArray & | result |
| ) |  |  |

PBoolean PXMLRPCBlock::GetParam | ( | PINDEX | idx,
|  | PXMLRPCStructBase & | result |
| ) |  |  |

PBoolean PXMLRPCBlock::GetParam | ( | PINDEX | idx,
|  | PStringToString & | result |
| ) |  |  |

PBoolean PXMLRPCBlock::GetParam | ( | PINDEX | idx,
|  | PTime & | result,
|  | int | tz = `PTime::GMT` |
| ) |  |  |

PBoolean PXMLRPCBlock::GetParam | ( | PINDEX | idx,
|  | double & | result |
| ) |  |  |

PBoolean PXMLRPCBlock::GetParam | ( | PINDEX | idx,
|  | int & | result |
| ) |  |  |

PBoolean PXMLRPCBlock::GetParam | ( | PINDEX | idx,
|  | PString & | result |
| ) |  |  |

PBoolean PXMLRPCBlock::GetParam | ( | PINDEX | idx,
|  | PString & | type,
|  | PString & | result |
| ) |  |  |

PXMLElement* PXMLRPCBlock::GetParam | ( | PINDEX | idx | ) | const

PINDEX PXMLRPCBlock::GetParamCount | ( |  | ) | const

PBoolean PXMLRPCBlock::GetParams | ( | PXMLRPCStructBase & | data | ) |

PXMLElement* PXMLRPCBlock::GetParams | ( |  | ) |

PBoolean PXMLRPCBlock::Load | ( | const PString & | str | ) |

PBoolean PXMLRPCBlock::ParseArray | ( | PXMLElement * | element,
|  | PXMLRPCVariableBase & | array |
| ) |  |  |

PBoolean PXMLRPCBlock::ParseArray | ( | PXMLElement * | element,
|  | PArray< PStringToString > & | array |
| ) |  |  |

PBoolean PXMLRPCBlock::ParseArray | ( | PXMLElement * | element,
|  | PStringArray & | array |
| ) |  |  |

PBoolean PXMLRPCBlock::ParseScalar | ( | PXMLElement * | element,
|  | PString & | type,
|  | PString & | value |
| ) |  |  |

PBoolean PXMLRPCBlock::ParseStruct | ( | PXMLElement * | element,
|  | PXMLRPCStructBase & | structData |
| ) |  |  |

PBoolean PXMLRPCBlock::ParseStruct | ( | PXMLElement * | element,
|  | PStringToString & | structDict |
| ) |  |  |

void PXMLRPCBlock::SetFault | ( | PINDEX | code,
|  | const PString & | text |
| ) |  |  | `[inline]`

PBoolean PXMLRPCBlock::ValidateResponse | ( |  | ) |

## Member Data Documentation

PINDEX PXMLRPCBlock::faultCode `[protected]`

PString PXMLRPCBlock::faultText `[protected]`

PXMLElement* PXMLRPCBlock::params `[protected]`

The documentation for this class was generated from the following file:

- pxmlrpc.h