Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

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

MXMXLWriterfollows XML 1.0 specifications and outputs BOM for encoding.

FALSE

MXMXLWriteris 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. MXXMLWriternever 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
Windows Embedded CE Windows CE .NET 4.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also