prt::Object Class Reference

#include <Object.h>

Inheritance diagram for prt::Object:

Public Member Functions
void	destroy () const
virtual char *	toXML (char *result, size_t *resultSize, Status *stat=0) const =0
char *	toXMLDocument (char *result, size_t *resultSize, Status *stat=0) const

Protected Member Functions
	Object (const Object &)

Detailed Description

The base class of all client-instantiable classes. prt objects can either be instantiated via static crate() call or a matching builder and must be destroyed via destroy().

Member Function Documentation

destroy()

void prt::Object::destroy

(

)

const

Destroys this instance.

toXML()

virtual char* prt::Object::toXML ( char *  result, size_t *  resultSize, Status *  stat = 0  ) const

pure virtual

Returns the XML representation of this object. Does not include any XML headers, for a full XML document see toXMLDocument(). Implemented by all subclasses.

If the result does not fit into the allocated buffer, the result is truncated. The INOUT parameter resultSize must be compared to the original buffer size after the call to detect this situation.

Parameters

[in,out]	result	Pointer to buffer to receive the null-terminated XML encoded representation.
[in,out]	resultSize	Pointer to size of reserved buffer; returns the size of the actual result (incl. terminating 0). Is always greater than 0.
[out]	stat	Optional pointer to return the status.

Returns

result.

toXMLDocument()

char* prt::Object::toXMLDocument	(	char *	result,
		size_t *	resultSize,
		Status *	stat = 0
	)		const

Dumps the object to a standalone XML document. Basically combines the output of toXML() with XML headers.

If the result does not fit into the allocated buffer, the result is truncated. the INOUT parameter resultSize must be compared to the original buffer size after the call to detect this situation.

Parameters

[in,out]	result	Pointer to buffer to receive the null-terminated XML encoded representation.
[in,out]	resultSize	Pointer to size of reserved buffer; returns the size of the actual result (incl. terminating 0). Is always greater than 0.
[out]	stat	Optional pointer to return the status.

Returns

result.

---

The documentation for this class was generated from the following file:

• Object.h