XdmWriterSettings.Encoding PropertyXdmWriterSettings.Encoding PropertyXdmWriterSettings::Encoding Property

Gets or sets the character encoding to be used.

Syntax

Public Property Encoding As String
        Get
        Set(ByVal value As String)
public string Encoding { get; set; }
public:
property String^ Encoding {
    String^ get();
    void set(String^ value);
}
 

Property Value

Type: System.StringSystem.StringSystem::String^

The character encoding to be used.

Exceptions

ExceptionCondition
XdmExceptionXdmExceptionXdmExceptionAn SEPM0016 error may be raised if an invalid encoding setting is attempted.

Remarks

This property corresponds to the encoding serialization parameter, which specifies the encoding to be used for outputting the instance of the data model.

The following encodings are supported (these values are case-insensitive):

  • IBM037
  • IBM500
  • IBM273
  • IBM277
  • IBM280
  • IBM284
  • IBM285
  • IBM297
  • IBM871
  • IBM1047
  • iso-8859-1
  • iso-8859-2
  • iso-8859-3
  • iso-8859-4
  • iso-8859-5
  • iso-8859-6
  • iso-8859-7
  • iso-8859-8
  • iso-8859-9
  • iso-8859-13
  • iso-8859-15
  • us-ascii
  • utf-8
  • utf-16
  • utf-16BE
  • utf-16LE
  • utf-32
  • utf-32BE
  • utf-32LE
  • GB18030
  • GB18030
  • unicodeFFFE
  • Windows-1252

If this property is set to an unsupported value and MethodMethodMethod is not set to CanonicalOutputMethodCanonicalOutputMethodCanonicalOutputMethod then a SESU0007 XdmExceptionXdmExceptionXdmException is raised if serialization is attempted.

This property is ignored when MethodMethodMethod is set to CanonicalOutputMethodCanonicalOutputMethodCanonicalOutputMethod. When serializing to a TextWriterTextWriterTextWriter the encoding specified by the text writer overrides this property.