OdString Class

Class Hierarchy

Syntax

C++

class OdString;

File

OdString.h

Description

This class implements character String objects in the ODA Platform.

Remarks

OdString objects use zero-based indices to access string elements.

Group

Other Classes

Public Methods

	Name	Description
	~OdString	This is ~OdString, a member of class OdString.
	OdString	This is the overview for the OdString constructor overload.

OdString Data Members

	Name	Description
	kEmpty	This is kEmpty, a member of class OdString.

OdString Methods

	Name	Description
	c_str	Returns the underlying OdChar array (buffer) of this String object.
	collate	This is collate, a member of class OdString.
	compare	This is the overview for the compare method overload.
	deleteChars	Deletes the specified number characters from this String object.
	empty	Sets this String object to the empty string.
	find	This is the overview for the find method overload.
	findOneOf	This is the overview for the findOneOf method overload.
	format	This is the overview for the format method overload.
	formatV	This is the overview for the formatV method overload.
	freeExtra	Releases any unused memory allocated by this String object.
	getAllocLength	Returns the number of characters allocated for the underlying OdChar array (buffer) in this String object.
	getAt	Returns the single character of this String object at the specified position.
	getBuffer	Returns a modifiable C style OdChar array (buffer) of the specified minimum length for this String object.
	getBufferSetLength	Returns a modifiable C style OdChar array (buffer) of of the specified length for this String object.
	getLength	Returns the number of characters in this String object.
	getLengthA	This is getLengthA, a member of class OdString.
	iCollate	This is iCollate, a member of class OdString.
	iCompare	This is the overview for the iCompare method overload.
	insert	This is the overview for the insert method overload.
	isEmpty	Returns true and only if this String object is empty.
	left	Returns the leftmost substring of the specified length from this String object.
	lockBuffer	Enables reference counting for this String object.
	makeLower	Converts this String object to lower case.
	makeReverse	Reverses this String object.
	makeUpper	Converts this String object to upper case.
	mid	This is the overview for the mid method overload.
	preallocate	Assures the character buffer of this String object is at least the specified size.
	releaseBuffer	Releases a buffer obtained by getBuffer() or getBufferSetLength(), and sets its length.
	remove	Removes all occurrences of the specified character from this String object.
	replace	This is the overview for the replace method overload.
	reverseFind	This is the overview for the reverseFind method overload.
	right	Returns the rightmost substring of the specified length from this String object.
	setAt	Sets the single character of this String object at the specified position.
	spanExcluding	This is the overview for the spanExcluding method overload.
	spanIncluding	This is the overview for the spanIncluding method overload.
	trimLeft	This is the overview for the trimLeft method overload.
	trimRight	This is the overview for the trimRight method overload.
	unlockBuffer	Disables reference counting for this String object.

OdString Operators

	Name	Description
	[]	Indexing Operator
	+=	This is the overview for the += operator overload.
	=	This is the overview for the = operator overload.
	const __wchar_t*	This is const __wchar_t*, a member of class OdString.
	const char*	This is const char*, a member of class OdString.
	const OdChar*	Returns the underlying character array (buffer) of this String object.

OdString Structures

	Name	Description
	lessnocase	Functional object to do case-less string comparison e.g. in functions.

Send feedback about this topic