ATE::IVersionInfo Class Reference

This object encapsulates version information for the Adobe Text Engine (ATE). More...

#include <IText.h>

List of all members.

Public Member Functions
	IVersionInfo ()
	Constructor.
	IVersionInfo (const IVersionInfo &src)
	Copy constructor.
IVersionInfo &	operator= (const IVersionInfo &rhs)
	Assignment operator.
bool	operator== (const IVersionInfo &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const IVersionInfo &rhs) const
	Comparison operator tests for inequality.
	IVersionInfo (VersionInfoRef versioninfo)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~IVersionInfo ()
	Destructor.
VersionInfoRef	GetRef () const
	Retrieves a reference to this object.
bool	IsNull () const
	Reports whether this is a null object.
int	GetMajorVersion ()
	Retrieves the major version portion of the version number.
int	GetMinorVersion ()
	Retrieves the minor version portion of the version number.
int	GetSubMinorVersion ()
	Retrieves the sub-minor version (patch) portion of the version number.
int	GetVersionAsUTF16 (ASUTF16 *versionString, int maxLength)
	Retrieves the version number as a string of UTF-16 characters.

---

Detailed Description

This object encapsulates version information for the Adobe Text Engine (ATE).

---

Constructor & Destructor Documentation

ATE::IVersionInfo::IVersionInfo

(

)

Constructor.

Returns:

The new object.

References ATE::sVersionInfo, and ATE::Throw_ATE_Exception().

ATE::IVersionInfo::IVersionInfo

(

const IVersionInfo &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sVersionInfo.

ATE::IVersionInfo::IVersionInfo

(

VersionInfoRef

versioninfo

)

[explicit]

Constructs this C++ object from the corresponding C object returned by an ATE suite function.

The C++ object manages reference counting.

Parameters:

versioninfo

The C object.

Returns:

The new C++ object.

ATE::IVersionInfo::~IVersionInfo

(

)

[virtual]

Destructor.

References ATE::sVersionInfo.

---

Member Function Documentation

int ATE::IVersionInfo::GetMajorVersion

(

)

Retrieves the major version portion of the version number.

Returns:

The major version value.

References ATE::sVersionInfo, and ATE::Throw_ATE_Exception().

int ATE::IVersionInfo::GetMinorVersion

(

)

Retrieves the minor version portion of the version number.

Returns:

The minor version value.

References ATE::sVersionInfo, and ATE::Throw_ATE_Exception().

VersionInfoRef ATE::IVersionInfo::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

int ATE::IVersionInfo::GetSubMinorVersion

(

)

Retrieves the sub-minor version (patch) portion of the version number.

Returns:

The sub-minor version value.

References ATE::sVersionInfo, and ATE::Throw_ATE_Exception().

int ATE::IVersionInfo::GetVersionAsUTF16	(	ASUTF16 *	versionString,
		int	maxLength
	)

Retrieves the version number as a string of UTF-16 characters.

For example:

 ASUTF16 versionString[256];
 GetVersionAsUTF16(versionString , 256);

Parameters:

	versionString	[out] A buffer in which to return the string.
	maxLength	The number of characters in the buffer.

References ATE::sVersionInfo, and ATE::Throw_ATE_Exception().

bool ATE::IVersionInfo::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sVersionInfo.

bool ATE::IVersionInfo::operator!=

(

const IVersionInfo &

rhs

)

const

Comparison operator tests for inequality.

Parameters:

rhs

The object to compare to this one.

Returns:

True if the two objects are not the same.

IVersionInfo & ATE::IVersionInfo::operator=

(

const IVersionInfo &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sVersionInfo.

bool ATE::IVersionInfo::operator==

(

const IVersionInfo &

rhs

)

const

Comparison operator tests for equality.

Parameters:

rhs

The object to compare to this one.

Returns:

True if the two objects are the same.

---

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

• IText.h
• IText.cpp