KGy SOFT Core Libraries Help
Xml
Serializes the object passed in obj into the provided Stream.
Definition
Namespace: KGySoft.Serialization.Xml
Assembly: KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 9.0.0-preview.1
Assembly: KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 9.0.0-preview.1
C#
public static void Serialize(
Stream stream,
Object? obj,
XmlSerializationOptions options = XmlSerializationOptions.CompactSerializationOfPrimitiveArrays|XmlSerializationOptions.EscapeNewlineCharacters
)VB
Public Shared Sub Serialize (
stream As Stream,
obj As Object,
Optional options As XmlSerializationOptions = XmlSerializationOptions.CompactSerializationOfPrimitiveArrays Or XmlSerializationOptions.EscapeNewlineCharacters
)C++
public:
static void Serialize(
Stream^ stream,
Object^ obj,
XmlSerializationOptions options = XmlSerializationOptions::CompactSerializationOfPrimitiveArrays|XmlSerializationOptions::EscapeNewlineCharacters
)F#
static member Serialize :
stream : Stream *
obj : Object *
?options : XmlSerializationOptions
(* Defaults:
let _options = defaultArg options XmlSerializationOptions.CompactSerializationOfPrimitiveArrays|XmlSerializationOptions.EscapeNewlineCharacters
*)
-> unit Parameters
- stream Stream
- A Stream used to write the XML document. The stream will not be closed after serialization.
- obj Object
- The Object to serialize.
- options XmlSerializationOptions (Optional)
- Options for serialization. This parameter is optional.
Default value: CompactSerializationOfPrimitiveArrays, EscapeNewlineCharacters
Exceptions
| ArgumentNullException | stream must not be null. |
| NotSupportedException | Serialization is not supported with provided options - or - The stream does not support writing. |
| ReflectionException | The object hierarchy to serialize contains circular reference. |
| IOException | An I/O error occurred. |
| ObjectDisposedException | The stream is already closed. |