Share via

WriteComment (Compact 2013)

  • Article

3/26/2014

This method writes out a comment that contains the specified text.

Syntax

HRESULT WriteComment (
  const WCHAR* pwszComment
);

Arguments

  • pwszComment
    The text of the comment. NULL is equal to an empty string.

Return Value

This method returns S_OK if no error is generated.

Remarks

This method produces a comment in the following format, where text is the text provided:

<!-- text -->

A text block that contains the characters "-->" signifies the end of a comment. This method will insert a space between the two "-" characters. This change to the text prevents the writer from producing an XML document that is not well-formed.

If the pwszComment parameter is NULL, the writer produces a comment that has no text.

See Also

Reference

IXmlWriter Methods
IXmlWriter Properties