Class XmlRpcResponse

Represents the response to an XML remote procedure call.

Inheritance
System.Object
XmlRpcResponse
Implements
System.IComparable
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Argotic.Net
Assembly: Argotic.Core.dll
Syntax
[Serializable]
public class XmlRpcResponse : IComparable
Examples

Constructors

| Improve this Doc View Source

XmlRpcResponse()

Initializes a new instance of the XmlRpcResponse class.

Declaration
public XmlRpcResponse()
| Improve this Doc View Source

XmlRpcResponse(IXmlRpcValue)

Initializes a new instance of the XmlRpcResponse class using the supplied IXmlRpcValue.

Declaration
public XmlRpcResponse(IXmlRpcValue parameter)
Parameters
Type Name Description
IXmlRpcValue parameter

A IXmlRpcValue that represents the response value that was returned for the remote procedure call.
Exceptions
Type Condition
System.ArgumentNullException

The parameter is a null reference (Nothing in Visual Basic).
| Improve this Doc View Source

XmlRpcResponse(XmlRpcStructureValue)

Initializes a new instance of the XmlRpcResponse class using the supplied XmlRpcStructureValue.

Declaration
public XmlRpcResponse(XmlRpcStructureValue fault)
Parameters
Type Name Description
XmlRpcStructureValue fault

A XmlRpcStructureValue that represents the response to the remote procedure call.
Exceptions
Type Condition
System.ArgumentNullException

The fault is a null reference (Nothing in Visual Basic).
| Improve this Doc View Source

XmlRpcResponse(Int32, String)

Initializes a new instance of the XmlRpcResponse class using the supplied fault code and message.

Declaration
public XmlRpcResponse(int faultCode, string faultMessage)
Parameters
Type Name Description
System.Int32 faultCode

Machine-readable code that identifies the reason the remote procedure call failed.
System.String faultMessage

Human-readable information about the reason the remote procedure call failed.
| Improve this Doc View Source

XmlRpcResponse(WebResponse)

Initializes a new instance of the XmlRpcResponse class using the supplied System.Net.WebResponse.

Declaration
public XmlRpcResponse(WebResponse response)
Parameters
Type Name Description
System.Net.WebResponse response

A System.Net.WebResponse object that represents the XML-RPC server's response to the remote procedure call.
Exceptions
Type Condition
System.ArgumentNullException

The response is a null reference (Nothing in Visual Basic).
System.ArgumentException

The response has an invalid content type.
System.ArgumentException

The response has an invalid content length.
System.Xml.XmlException

The response body does not represent a valid XML document, or an error was encountered in the XML data.

Properties

| Improve this Doc View Source

Fault

Gets the fault information that was returned for the remote procedure call.

Declaration
public XmlRpcStructureValue Fault { get; }
Property Value
Type Description
XmlRpcStructureValue

A XmlRpcStructureValue that represents the fault information that was returned for the remote procedure call. If the remote procedure call executed without errors, will return null.
See Also
| Improve this Doc View Source

Parameter

Gets the response information that was returned for the remote procedure call.

Declaration
public IXmlRpcValue Parameter { get; }
Property Value
Type Description
IXmlRpcValue

A IXmlRpcValue that represents the response value that was returned for the remote procedure call. If the remote procedure call raised an execption, will return null and the Fault should be populated.
See Also

Methods

| Improve this Doc View Source

CompareTo(Object)

Compares the current instance with another object of the same type.

Declaration
public int CompareTo(object obj)
Parameters
Type Name Description
System.Object obj

An object to compare with this instance.
Returns
Type Description
System.Int32

A 32-bit signed integer that indicates the relative order of the objects being compared.
Exceptions
Type Condition
System.ArgumentException

The obj is not the expected System.Type.
| Improve this Doc View Source

Equals(Object)

Determines whether the specified System.Object is equal to the current instance.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj

The System.Object to compare with the current instance.
Returns
Type Description
System.Boolean

true if the specified System.Object is equal to the current instance; otherwise, false.
Overrides
System.Object.Equals(System.Object)
| Improve this Doc View Source

GetHashCode()

Returns a hash code for the current instance.

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32

A 32-bit signed integer hash code.
Overrides
System.Object.GetHashCode()
| Improve this Doc View Source

Load(XPathNavigator)

Loads this XmlRpcResponse using the supplied System.Xml.XPath.XPathNavigator.

Declaration
public bool Load(XPathNavigator source)
Parameters
Type Name Description
System.Xml.XPath.XPathNavigator source

The System.Xml.XPath.XPathNavigator to extract information from.
Returns
Type Description
System.Boolean

true if the XmlRpcResponse was initialized using the supplied source, otherwise false.
Remarks

This method expects the supplied source to be positioned on the XML element that represents a XmlRpcResponse.

Exceptions
Type Condition
System.ArgumentNullException

The source is a null reference (Nothing in Visual Basic).
| Improve this Doc View Source

ToString()

Returns a System.String that represents the current XmlRpcMessage.

Declaration
public override string ToString()
Returns
Type Description
System.String

A System.String that represents the current XmlRpcMessage.
Overrides
System.Object.ToString()
Remarks

This method returns the XML representation for the current instance.

| Improve this Doc View Source

WriteTo(XmlWriter)

Saves the current XmlRpcResponse to the specified System.Xml.XmlWriter.

Declaration
public void WriteTo(XmlWriter writer)
Parameters
Type Name Description
System.Xml.XmlWriter writer

The System.Xml.XmlWriter to which you want to save.
Exceptions
Type Condition
System.ArgumentNullException

The writer is a null reference (Nothing in Visual Basic).

Operators

| Improve this Doc View Source

Equality(XmlRpcResponse, XmlRpcResponse)

Determines if operands are equal.

Declaration
public static bool operator ==(XmlRpcResponse first, XmlRpcResponse second)
Parameters
Type Name Description
XmlRpcResponse first

Operand to be compared.
XmlRpcResponse second

Operand to compare to.
Returns
Type Description
System.Boolean

true if the values of its operands are equal, otherwise; false.
| Improve this Doc View Source

GreaterThan(XmlRpcResponse, XmlRpcResponse)

Determines if first operand is greater than second operand.

Declaration
public static bool operator>(XmlRpcResponse first, XmlRpcResponse second)
Parameters
Type Name Description
XmlRpcResponse first

Operand to be compared.
XmlRpcResponse second

Operand to compare to.
Returns
Type Description
System.Boolean

true if the first operand is greater than the second, otherwise; false.
| Improve this Doc View Source

Inequality(XmlRpcResponse, XmlRpcResponse)

Determines if operands are not equal.

Declaration
public static bool operator !=(XmlRpcResponse first, XmlRpcResponse second)
Parameters
Type Name Description
XmlRpcResponse first

Operand to be compared.
XmlRpcResponse second

Operand to compare to.
Returns
Type Description
System.Boolean

false if its operands are equal, otherwise; true.
| Improve this Doc View Source

LessThan(XmlRpcResponse, XmlRpcResponse)

Determines if first operand is less than second operand.

Declaration
public static bool operator <(XmlRpcResponse first, XmlRpcResponse second)
Parameters
Type Name Description
XmlRpcResponse first

Operand to be compared.
XmlRpcResponse second

Operand to compare to.
Returns
Type Description
System.Boolean

true if the first operand is less than the second, otherwise; false.

Implements

System.IComparable

See Also