RiverSoftAVG Products Help

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Send Mail Feedback
Save Permalink URL

Navigation: Code Documentation > RSCommon > GValue > Classes

TGCustomValue Class

Implements an object that can hold any type of value; Integer,
Float, Boolean, Object, etc.; and can convert between them. Since it avoids all pointers to values, There are a few issues:

1. If you use AsInterface, it better well be an interface or
you will get an access error

2. The Precision of Currency is only what will fit in Single

3. AsVariant does not truly store the variant.

The bulk of the class is just properties and their accessor methods for retrieving values of the different types. The class does not guarantee type conversion between all the types, but the basic conversions have been implemented.

For Windows platforms only.

Note
This class is extremely similar to the TIEValue class in the Inference Engine Component Suite, but without the IECS specific code.

Namespace: GValue

	Name	Description
	Create	Creates the generic value. The value is GValue.TGCustomValue.Unassigned.
	CreateValue(TVarRec)	Creates the value object and assigns the AValue to the new object.

Top

	Name	Description
	AsBoolean	Allows the user to get and set the value inside the object as a boolean. When you assign a value using the AsBoolean property, the VType property is changed to vtBoolean.
	AsChar	Allows the user to get and set the value inside the object as a character. When you assign a value using the AsChar property, the VType property is changed to vtChar.
	AsClass	Allows the user to get and set the value inside the object as a class. When you assign a value using the AsClass property, the VType property is changed to vtClass.
	AsCurrency	Allows the user to get and set the value inside the object as a currency value. When you assign a value using the AsCurrency property, the VType property is changed to vtCurrency.
	AsFloat	Allows the user to get and set the value inside the object as a floating point number. When you assign a value using the AsFloat property, the VType property is changed to vtFloat.
	AsInteger	Allows the user to get and set the value inside the object as an integer. When you assign a value using the AsInteger property, the VType property is changed to vtInteger.
	AsInterface	Allows the user to get and set the value inside the object as an interface. When you assign a value using the AsInterface property, the VType property is changed to vtInterface.
	AsObject	Allows the user to get and set the value inside the object as an object. When you assign a value using the AsObject property, the VType property is changed to vtObject.
	AsPChar	Allows the user to get and set the value inside the object as a pointer to a character. When you assign a value using the AsPChar property, the VType property is changed to vtPChar.
	AsPointer	Allows the user to get and set the value inside the object as a pointer. When you assign a value using the AsPointer property, the VType property is changed to vtPointer.
	AsString	Allows the user to get and set the value inside the object as a string. When you assign a value using the AsString property, the VType property is changed to vtString.
	AsVariant	Allows the user to get and set the value inside the object as a variant. When you assign a value using the AsVariant property, the VType property is changed to vtVariant.
	AsWideString	Allows the user to get and set the value inside the object as a wide string. When you assign a value using the AsWideString property, the VType property is changed to vtWideString.
	Unassigned	Returns true if a value has not been assigned to the object through an AsXXX property assignment.
	Value	Stores the value in the object
	VType	Returns the type of the value in the object. VType is set by calling one of the AsXXX methods.

Top

	Name	Description
	Assign(TGCustomValue)	Copies the source value to the current value
	AssignVarRec(TVarRec)	Copies the source TVarRect to the current value.
	Clone(TGCustomValue)	Creates a TGCustomValue (if Dest is nil) and then copies the current value into the clone.
	Equals(TGCustomValue)	Returns true if the current value equals the input AValue.
	GetAsBoolean	Returns the value converted to a boolean
	GetAsChar	Returns the value converted to a character
	GetAsClass	Returns the value converted to a class
	GetAsCurrency	Returns the value converted to currency
	GetAsFloat	Returns the value converted to an native sized floating point number
	GetAsInteger	Returns the value converted to an integer
	GetAsInterface	Returns the value converted to an interface
	GetAsObject	Returns the value converted to a TObject
	GetAsPointer	Returns the value converted to a pointer
	GetAsString	Returns the value converted to a string
	GetAsVariant	Returns the value converted to a variant
	GetAsWideString	Returns the value converted to a wide string
	GetValueType	Returns the type of the value in the object.
	SetAsBoolean(Boolean)	Stores a boolean in the object. The previous value is discarded.
	SetAsChar(Char)	Stores a character in the object. The previous value is discarded.
	SetAsClass(TClass)	Stores a class in the object. The previous value is discarded.
	SetAsCurrency(Currency)	Stores a currency value in the object. The previous value is discarded.
	SetAsFloat(TRSNativeFloat)	Stores a floating point number in the object. The previous value is discarded.
	SetAsInteger(Integer)	Stores an integer in the object. The previous value is discarded.
	SetAsInterface(IUnknown)	Stores an interface in the object. The previous value is discarded.
	SetAsObject(TObject)	Stores an object in the object. The previous value is discarded.
	SetAsPointer(Pointer)	Stores a pointer in the object. The previous value is discarded.
	SetAsString(String)	Stores a string in the object. The previous value is discarded.
	SetAsVariant(Variant)	Stores a variant in the object. The previous value is discarded.
	SetAsWideString(WideString)	Stores a wide string in the object. The previous value is discarded.

Top

RiverSoftAVG Products Help

Reference