byteOrderMark Property (Compact 2013)

  • Article

3/26/2014

This property determines whether or not to write the Byte Order Mark (BOM).

Syntax

[proput]
HRESULT byteOrderMark(
  [in] VARIANT_BOOL fWriteByteOrderMark
);
[propget]
HRESULT byteOrderMark(
  [out, retval] VARIANT_BOOL* fWriteByteOrderMark
);

Parameters

  • fWriteByteOrderMark
    Boolean expression (TRUE/FALSE) specifying whether the feature is on or off, as shown in the following table.

    Value

    Description

    TRUE

    MXMXLWriter follows XML 1.0 specifications and outputs BOM for encoding.

    FALSE

    MXMXLWriter is prohibited from putting BOM into the resulting XML document.

Remarks

You can use this property to output fragments of larger XML documents that can be assembled into a single XML document later.

The default of this property is dependent on implementation. MXXMLWriter never outputs BOM if the output is set to a string.

Return Value

  • S_OK
    Returned if no errors are reported.

Requirements

Header

msxml2.h,
msxml2.idl

See Also

Reference

IMXWriter
transformNodeToObject Method