DeviceXml

Static class in Oadm.Sdk.Vapix · Oadm.Sdk.dll

The only way OADM and its plugins parse XML that came from a device: documents of at most DeviceXml.MaxCharacters characters (1 MB), DTD processing prohibited, no external resolver. Too large, a DTD or malformed XML throw XmlException.

public static class DeviceXml

Guide: Devices and VAPIX

Methods

CreateReaderSettings

static XmlReaderSettings CreateReaderSettings()

New reader settings with the limits (callers may add options such as IgnoreComments).

Parse

static XDocument Parse(string xml, LoadOptions options = None)

Parses a document from a device.

Exceptions

• XmlException: Malformed, larger than 1 MB or with a DTD.

Parse

static XDocument Parse(string xml, XmlReaderSettings settings, LoadOptions options = None)

Parses a document from a device with adjusted settings; the limits are enforced again.

Exceptions

• XmlException: Malformed, larger than 1 MB or with a DTD.

ParseElement

static XElement ParseElement(string xml, LoadOptions options = None)

The root element of a document from a device.

Exceptions

• XmlException: Malformed, larger than 1 MB, with a DTD or without a root element.

Fields

MaxCharacters

const int MaxCharacters = 1048576

Largest XML document parsed from a device (1 MB of characters).