Class XmlRpcStructureValue

Represents a remote procedure parameter value that is typically used to encapsulate small groups of related variables.

Inheritance

System.Object

XmlRpcStructureValue

Implements

IXmlRpcValue

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 XmlRpcStructureValue : IXmlRpcValue, IComparable

Constructors

XmlRpcStructureValue()

Initializes a new instance of the XmlRpcStructureValue class.

Declaration

public XmlRpcStructureValue()

XmlRpcStructureValue(XPathNodeIterator)

Initializes a new instance of the XmlRpcStructureValue class using the supplied System.Xml.XPath.XPathNodeIterator.

Declaration

public XmlRpcStructureValue(XPathNodeIterator iterator)

Parameters

Type	Name	Description
System.Xml.XPath.XPathNodeIterator	iterator	A System.Xml.XPath.XPathNodeIterator that represents the member nodes for the structured list.

Exceptions

Type	Condition
System.ArgumentNullException	The iterator is a null reference (Nothing in Visual Basic).

Properties

Item[String]

Gets or sets the XmlRpcStructureMember that has the specified name.

Declaration

public XmlRpcStructureMember this[string name] { get; set; }

Parameters

Type	Name	Description
System.String	name	The name that uniquely identifies the member to get or set.

Property Value

Type	Description
XmlRpcStructureMember	The XmlRpcStructureMember with the specified name.

Remarks

If no member exists for the specified name, returns a null reference. This indexer uses a case insensitive comparison of the specified member name.

Exceptions

Type	Condition
System.ArgumentNullException	The name is a null reference (Nothing in Visual Basic).
System.ArgumentNullException	The name is an empty string.
System.ArgumentNullException	The value is a null reference (Nothing in Visual Basic).

Members

Gets this structure's members.

Declaration

public Collection<XmlRpcStructureMember> Members { get; }

Property Value

Type	Description
System.Collections.ObjectModel.Collection<XmlRpcStructureMember>	A System.Collections.ObjectModel.Collection<T> collection of XmlRpcStructureMember objects that represent this structure's members. The default value is an empty collection.

Methods

CompareSequence(Collection<XmlRpcStructureMember>, Collection<XmlRpcStructureMember>)

Compares two specified System.Collections.ObjectModel.Collection<T> collections.

Declaration

public static int CompareSequence(Collection<XmlRpcStructureMember> source, Collection<XmlRpcStructureMember> target)

Parameters

Type	Name	Description
System.Collections.ObjectModel.Collection<XmlRpcStructureMember>	source	The first collection.
System.Collections.ObjectModel.Collection<XmlRpcStructureMember>	target	The second collection.

Returns

Type	Description
System.Int32	A 32-bit signed integer indicating the lexical relationship between the two comparands.

Remarks

If the collections contain the same number of elements, determines the lexical relationship between the two sequences of comparands.

If the source has an element count that is greater than the target element count, returns 1.

If the source has an element count that is less than the target element count, returns -1.

Exceptions

Type	Condition
System.ArgumentNullException	The source is a null reference (Nothing in Visual Basic).
System.ArgumentNullException	The target is a null reference (Nothing in Visual Basic).

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.

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)

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()

Load(XPathNavigator)

Loads this XmlRpcStructureValue 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 XmlRpcStructureValue 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 XmlRpcStructureValue.

Exceptions

Type	Condition
System.ArgumentNullException	The source is a null reference (Nothing in Visual Basic).

ToString()

Returns a System.String that represents the current XmlRpcStructureValue.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A System.String that represents the current XmlRpcStructureValue.

Overrides

System.Object.ToString()

Remarks

This method returns the XML representation for the current instance.

WriteTo(XmlWriter)

Saves the current XmlRpcStructureValue 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

Equality(XmlRpcStructureValue, XmlRpcStructureValue)

Determines if operands are equal.

Declaration

public static bool operator ==(XmlRpcStructureValue first, XmlRpcStructureValue second)

Parameters

Type	Name	Description
XmlRpcStructureValue	first	Operand to be compared.
XmlRpcStructureValue	second	Operand to compare to.

Returns

Type	Description
System.Boolean	true if the values of its operands are equal, otherwise; false.

GreaterThan(XmlRpcStructureValue, XmlRpcStructureValue)

Determines if first operand is greater than second operand.

Declaration

public static bool operator>(XmlRpcStructureValue first, XmlRpcStructureValue second)

Parameters

Type	Name	Description
XmlRpcStructureValue	first	Operand to be compared.
XmlRpcStructureValue	second	Operand to compare to.

Returns

Type	Description
System.Boolean	true if the first operand is greater than the second, otherwise; false.

Inequality(XmlRpcStructureValue, XmlRpcStructureValue)

Determines if operands are not equal.

Declaration

public static bool operator !=(XmlRpcStructureValue first, XmlRpcStructureValue second)

Parameters

Type	Name	Description
XmlRpcStructureValue	first	Operand to be compared.
XmlRpcStructureValue	second	Operand to compare to.

Returns

Type	Description
System.Boolean	false if its operands are equal, otherwise; true.

LessThan(XmlRpcStructureValue, XmlRpcStructureValue)

Determines if first operand is less than second operand.

Declaration

public static bool operator <(XmlRpcStructureValue first, XmlRpcStructureValue second)

Parameters

Type	Name	Description
XmlRpcStructureValue	first	Operand to be compared.
XmlRpcStructureValue	second	Operand to compare to.

Returns

Type	Description
System.Boolean	true if the first operand is less than the second, otherwise; false.

Implements

IXmlRpcValue

System.IComparable

See Also

Parameters

IXmlRpcValue