Share via


byteOrderMark Property

 

Determines whether to write the Byte Order Mark (BOM) to MXXMLWriter output. Setting the byteOrderMark property to False prohibits the writer from putting the Byte Order Mark (BOM) into the resulting XML document or document fragment. This property is useful for creating document fragments. Setting this property to True makes MXXMLWriter follow XML 1.0 specifications and output the Byte Order Mark for appropriate encoding.

Visual Basic Usage Syntax

oMXXMLWriter.byteOrderMark = boolValue  
boolValue = oMXXMLWriter.byteOrderMark  

C/C++ Syntax

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

Parameters

fWriteByteOrderMark
A Boolean expression (True/False) specifying whether the feature is on or off.

Return Values

S_OK
The value returned if no errors are reported.

Remarks

Read/write. The default is True. MXXMLWriter never generates a BOM if the output is set to a string.

Value Description
True MXMXLWriter follows XML 1.0 specifications and outputs BOM for encoding.
False MXMXLWriter does not write the BOM into the resulting XML output.

Versioning

Implemented in: MSXML 3.0 and later

Applies to

MXXMLWriter CoClass