FDO API Reference

Feature Data Objects

FdoStringValue Class Reference

#include <StringValue.h>

Inherits FdoDataValue.

Inheritance diagram for FdoStringValue:

[legend]List of all members.

---

Detailed Description

The FdoStringValue class derives from FdoDataValue and represents a literal string.

Definition at line 32 of file StringValue.h.

Public Member Functions
FDO_API FdoDataType	GetDataType ()
	Gets the data type of the FdoStringValue.
FDO_API FdoString *	GetString ()
	Gets the FdoStringValue as a string.
FDO_API	operator wchar_t * ()
	A cast operator to get the string.
FDO_API void	Process (FdoIExpressionProcessor *p)
	Overrides FdoExpression.Process to pass the FdoStringValue to the appropriate expression processor operation.
FDO_API void	SetNull ()
	Sets the FdoStringValue to a null value.
FDO_API void	SetString (FdoString *value)
	Sets the FdoStringValue as a string.
FDO_API FdoString *	ToString ()
	Returns the well defined text representation of this expression.
Static Public Member Functions
FDO_API FdoStringValue *	Create (FdoString *value)
	Constructs a default instance of an FdoStringValue using the specified arguments.
FDO_API FdoStringValue *	Create ()
	Constructs a default instance of an FdoStringValue with a value of null.
Protected Member Functions
virtual void	Dispose ()
	Dispose this object.
virtual FdoCompareType	DoCompare (FdoDataValue *other)
	Type-specific comparison function. Each sub-class has its own implementation.
	FdoStringValue (FdoString *value)
	Constructs a default instance of an FdoStringValue using the specified arguments.
	FdoStringValue ()
	DOXYGEN-IGNORE Constructs a default instance of an FdoStringValue with a value of null.
virtual	~FdoStringValue ()
	Default destructor for FdoStringValue.
Protected Attributes
size_t	m_allocatedSize
wchar_t *	m_data

---

Constructor & Destructor Documentation

FdoStringValue::FdoStringValue (   )  [protected]

DOXYGEN-IGNORE Constructs a default instance of an FdoStringValue with a value of null. Returns: Returns nothing

FdoStringValue::FdoStringValue (  FdoString *  value  )  [protected]

Constructs a default instance of an FdoStringValue using the specified arguments. Returns: Returns nothing

virtual FdoStringValue::~FdoStringValue (   )  [protected, virtual]

Default destructor for FdoStringValue.

---

Member Function Documentation

FDO_API FdoStringValue* FdoStringValue::Create (  FdoString *  value  )  [static]

Constructs a default instance of an FdoStringValue using the specified arguments. Parameters: value  Input a character string Returns: Returns the created FdoStringValue Reimplemented from FdoDataValue.

FDO_API FdoStringValue* FdoStringValue::Create (   )  [static]

Constructs a default instance of an FdoStringValue with a value of null. Returns: Returns the created FdoStringValue

virtual void FdoStringValue::Dispose (   )  [protected, virtual]

Dispose this object. Returns: Returns nothing Implements FdoIDisposable.

virtual FdoCompareType FdoStringValue::DoCompare (  FdoDataValue *  other  )  [protected, virtual]

Type-specific comparison function. Each sub-class has its own implementation. Parameters: other  Input the other data value Returns: Returns: FdoCompareType_Equal when this and the other value are equal or both null. FdoCompareType_Greater when this value is greater than the other value FdoCompareType_Less when this value is less than the other value FdoCompareType_Undefined when these two values cannot be compared. Cases where this happens are: one value is null and the other is not null the values have incompatible types (e.g. Int32 and DateTime). Base implementation always returns FdoCompareType_Undefined. Reimplemented from FdoDataValue.

FDO_API FdoDataType FdoStringValue::GetDataType (   )  [virtual]

Gets the data type of the FdoStringValue. Returns: Returns FdoDataType Implements FdoDataValue.

FDO_API FdoString* FdoStringValue::GetString (   )

Gets the FdoStringValue as a string. Returns: Returns a character string

FDO_API FdoStringValue::operator wchar_t * (   )  [inline]

A cast operator to get the string. Returns: Returns a character string Definition at line 139 of file StringValue.h. References FDO_API.

FDO_API void FdoStringValue::Process (  FdoIExpressionProcessor *  p  )  [virtual]

Overrides FdoExpression.Process to pass the FdoStringValue to the appropriate expression processor operation. Parameters: p  Input an FdoIExpressionProcessor Returns: Returns nothing Implements FdoExpression.

FDO_API void FdoStringValue::SetNull (   )  [virtual]

Sets the FdoStringValue to a null value. Returns: Returns nothing Reimplemented from FdoDataValue.

FDO_API void FdoStringValue::SetString (  FdoString *  value  )

Sets the FdoStringValue as a string. Parameters: value  Input a character string Returns: Returns nothing

FDO_API FdoString* FdoStringValue::ToString (   )  [virtual]

Returns the well defined text representation of this expression. Returns: Returns a character string Implements FdoExpression.

---

Member Data Documentation

size_t FdoStringValue::m_allocatedSize [protected]

Definition at line 149 of file StringValue.h.

wchar_t* FdoStringValue::m_data [protected]

Definition at line 148 of file StringValue.h.

---

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

• StringValue.h

---

Comments or suggestions? Send us feedback.