• Skip to main content
  • Skip to header right navigation
  • Skip to site footer
CDP Studio logo

CDP Studio

Software development tool for distributed control systems

  • Why CDP
    • Software developers
    • Automation engineers
    • Managers
  • Product
    • Design UI
    • Develop
    • Analyze and test
    • Deploy
    • Framework and toolbox
    • Compatibility
  • Services
  • Use cases
  • Pricing
  • Try CDP

CDP Studio Documentation

  • Framework - XMLParser
  • XMLComment

XMLComment Class

The XMLComment class handles parsing of, and holds an XMLComment. More...

Header: #include <XMLComment>
Inherits: XMLPrimitive
  • List of all members, including inherited members

Public Functions

XMLComment(void)
virtual ~XMLComment(void)
XMLComment *GetChild()
XMLComment *GetNext()
XMLComment *GetPrevious()

Reimplemented Public Functions

virtual bool Dump(FILE *pFile)
virtual char *Dump(char *pzBuffer)
virtual void Dump(XMLBuffer &strBuffer)
virtual unsigned int GetWriteBufferSize()
virtual const char *Parse(const char *pStart, unsigned int &nLineNumber)
  • 37 public functions inherited from XMLPrimitive

Additional Inherited Members

  • 1 static public member inherited from XMLPrimitive

Detailed Description

The XMLComment class handles parsing of, and holds an XMLComment.

Example XMLComment:

<!-- This is a comment. Anything in here is ignored, all up until the comment end: -->

The comment can be retrieved by calling GetName(), and can be set by calling SetName().

Member Function Documentation

XMLComment::XMLComment(void)

Constructs the XMLComment, setting the Type to e_XMLComment.

[virtual] XMLComment::~XMLComment(void)

Destructs the XMLComment.

[virtual] bool XMLComment::Dump(FILE *pFile)

Reimplemented from XMLPrimitive::Dump().

Appends the XMLComment to the already open pFile.

[virtual] char *XMLComment::Dump(char *pzBuffer)

Reimplemented from XMLPrimitive::Dump().

Appends the XMLComment to pzBuffer.

See also GetWriteBufferSize().

[virtual] void XMLComment::Dump(XMLBuffer &strBuffer)

Reimplemented from XMLPrimitive::Dump().

Appends the XMLComment to strBuffer.

XMLComment *XMLComment::GetChild()

Returns the first child element of type XMLComment, or nullptr if none.

XMLComment *XMLComment::GetNext()

Get the next XMLPrimitive of type XMLComment at this level, or nullptr if none.

XMLComment *XMLComment::GetPrevious()

Returns the previous XML primitive of type XMLComment at this level , or nullptr if none.

[virtual] unsigned int XMLComment::GetWriteBufferSize()

Reimplemented from XMLPrimitive::GetWriteBufferSize().

Returns the size that this XMLComment occupies when performing Dump(FILE*).

[virtual] const char *XMLComment::Parse(const char *pStart, unsigned int &nLineNumber)

Reimplemented from XMLPrimitive::Parse().

Parses the XMLComment, and reports error for nested comments or missing end of comment.

The content of this document is confidential information not to be published without the consent of CDP Technologies AS.

CDP Technologies AS, www.cdpstudio.com

Get started with CDP Studio today

Let us help you take your great ideas and turn them into the products your customer will love.

Try CDP Studio for free
Why CDP Studio?

CDP Technologies AS
Hundsværgata 8,
P.O. Box 144
6001 Ålesund, Norway

Tel: +47 990 80 900
E-mail: info@cdptech.com

Company

About CDP

Contact us

Services

Partners

Blog

Developers

Get started

User manuals

Support

Document download

Release notes

Follow CDP

    © Copyright 2021 CDP Technologies. Privacy and cookie policy.

    Return to top