Class: TUnicodeArray

Declaration: UnicodeArray.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

TSimpleUnicodeArray TToken

Purpose:

Provides base protocol for encapsulating and manipulating nonstyled, nondisplayable strings of Unicode characters.

Instantiation:

Abstract base class; do not allocate directly.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TUnicodeArray::~TUnicodeArray

virtual ~ TUnicodeArray ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TUnicodeArray::operator==

bool operator ==(const TUnicodeArray & that) const

Interface Category:

API.

Purpose:

Determines if two objects are equal.

Calling Context:

Called to compare two objects of this class.

Parameters:

const TUnicodeArray & that -The object to compare with this object.

Return Value:

Returns true if the objects are equal.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TUnicodeArray::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Returns the hash value for the collection. Note: This is a required override for every MCollectible derived class.

Calling Context:

Called by the static function ComputeHash.

Parameters:

Takes no parameters.

Return Value:

The numeric value of the hash.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TUnicodeArray::operator>>=

virtual TStream & operator >>=(TStream &) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & toWhere -The stream the object streams itself out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TUnicodeArray::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromWhere -The stream the object streams itself in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TUnicodeArray::GetLength

virtual TTextCount GetLength () const

Interface Category:

API.

Purpose:

Returns the length of the encapsulated character string.

Calling Context:

Called to get the length of the encapsulated character string.

Parameters:

Takes no parameters.

Return Value:

The length of the encapsulated character string.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TUnicodeArray::GetData

virtual TTextCount GetData (UniChar that [], TTextCount thatLength) const
virtual TTextCount GetData (UniChar that [], TTextCount thatLength, const TTextRange & thisRange) const
virtual TTextCount GetData (char that [], TTextCount thatLength) const
virtual TTextCount GetData (char that [], TTextCount thatLength, const TTextRange & thisRange) const

Interface Category:

API.

Purpose:

Gets the character string encapsulated by this object as a UniChar array.
Gets the character string encapsulated by this object as a UniChar array.
Gets the character string encapsulated by this object as a char array.
Gets the character string encapsulated by this object as a char array.

Calling Context:

Called to get the character string encapsulated by this object.
Called to get the character string encapsulated by this object.
Called to get the character string encapsulated by this object.
Called to get the character string encapsulated by this object.

Parameters:

UniChar that [] -The UniChar array encapsulated by this object.
TTextCount thatLength -The length of the array.
UniChar that [] -The UniChar array encapsulated by this object.
TTextCount thatLength -The length of the array.
const TTextRange & thisRange -The range to return.
char that [] -The char array encapsulated by this object.
TTextCount thatLength -The length of the array.
char that [] -The char array encapsulated by this object.
TTextCount thatLength -The length of the array.
const TTextRange & thisRange -The range to return.

Return Value:

The actual length of the returned array.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TUnicodeArray::SetData

virtual void SetData (const UniChar that [], const TTextRange & thatRange)
virtual void SetData (const char that [], const TTextRange & thatRange)

Interface Category:

API.

Purpose:

Replaces the string in this object with the specified string.
Replaces the string in this object with the specified string.

Calling Context:

Called to replace the string in this object with the specified string.
Called to replace the string in this object with the specified string.

Parameters:

const UniChar that [] -The string to replace the current string.
const TTextRange & thatRange -The range of the string to use.
const char that [] -The string to replace the current string.
const TTextRange & thatRange -The range of the string to use.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TUnicodeArray::ComputeHash

static long ComputeHash (UniChar fieldData [], TTextCount length)

Interface Category:

API.

Purpose:

Computes the hash value of a UniChar array of a specified length.

Calling Context:

Called by derived classes to compute the hash value of a UniChar array of a specified length.

Parameters:

UniChar fieldData [] -The array.
TTextCount length -The length of the array.

Return Value:

The numeric hash value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

The value returned by this function must be the value returned by Hash for all derived classes of TUnicodeArray.

Member Function: TUnicodeArray::CheapUniCharCopy

static void CheapUniCharCopy (const UniChar source [], UniChar target [], TTextCount characterCount)

Interface Category:

API.

Purpose:

Copies a UniChar array into another UniChar array.

Calling Context:

Called to copy a UniChar array into another UniChar array.

Parameters:

const UniChar source [] -The source array for the copy operation.
UniChar target [] -The target array for the copy operation.
TTextCount characterCount -The number of characters to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TUnicodeArray::CopyUniCharToChar

static void CopyUniCharToChar (const UniChar source [], char target [], TTextCount characterCount)

Interface Category:

API.

Purpose:

Copies a UniChar array to a char array.

Calling Context:

Called to copy a UniChar array to a char array.

Parameters:

const UniChar source [] -The source UniChar array.
char target [] -The target char array.
TTextCount characterCount -The number of characters to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TUnicodeArray::CopyCharToUniChar

static void CopyCharToUniChar (const unsigned char source [], UniChar target [], TTextCount characterCount)

Interface Category:

API.

Purpose:

Copies a char array to a UniChar array.

Calling Context:

Called to copy a char array to a UniChar array.

Parameters:

const unsigned char source [] -The source char array.
UniChar target [] -The target UniChar array.
TTextCount characterCount -The number of characters to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TUnicodeArray::TUnicodeArray

TUnicodeArray ()
TUnicodeArray (const TUnicodeArray &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called by the stream-in operators.
Called to copy an object.

Parameters:

Takes no parameters.
const TUnicodeArray & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TUnicodeArray::operator=

TUnicodeArray & operator =(const TUnicodeArray &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TUnicodeArray & -The source object for the assignment.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.