XmlBinaryWriterSession.TryAdd(XmlDictionaryString, Int32) Method

Definition

Namespace:

System.Xml

Assembly:

System.Runtime.Serialization.Xml.dll

Source:

XmlBinaryWriterSession.cs

Tries to add an XmlDictionaryString to the internal collection.

public:
 virtual bool TryAdd(System::Xml::XmlDictionaryString ^ value, [Runtime::InteropServices::Out] int % key);

public virtual bool TryAdd (System.Xml.XmlDictionaryString value, out int key);

abstract member TryAdd : System.Xml.XmlDictionaryString * int -> bool
override this.TryAdd : System.Xml.XmlDictionaryString * int -> bool

Public Overridable Function TryAdd (value As XmlDictionaryString, ByRef key As Integer) As Boolean

Parameters

value

XmlDictionaryString

The XmlDictionaryString to add.

key

Int32

The key of the XmlDictionaryString that was successfully added.

Returns

Boolean

true if the string could be added; otherwise, false.

Exceptions

ArgumentNullException

value is null.

InvalidOperationException

An entry with key = key already exists.

Remarks

When you use this class you must override this method to send the collection of keys along with the message. Without overriding, a new key is added to the collection, which is saved, but not sent with the message.