Variant Support Routines

From Appmethod Topics
Jump to: navigation, search

Go Up to API Categories Index

This topic lists all Variant support routines defined in the Object Pascal RTL.

Routine Description

System.Variants.DynArrayFromVariant

Creates a dynamic array from a Variant.

System.Variants.DynArrayToVariant

Creates a Variant array from a dynamic array.

System.Variants.FindCustomVariantType

Retrieves the object that implements a custom Variant type.

System.Variants.FindVarData

Returns pointer to Variant's data.

System.Variants.HandleConversionException

Handles exceptions during Variant type conversions.

System.Variants.Null

Returns a System.Variants.Null Variant.

System.Variants.Unassigned

Returns an "empty" Variant.

System.Variants.VarArrayCreate

Creates a Variant array.

System.Variants.VarArrayCreateError

Indicates an array creation error.

System.Variants.VarArrayDimCount

Returns number of dimensions of a Variant array.

System.Variants.VarArrayGet

Returns a Variant that represents a single value from a multi-dimensional Variant array.

System.Variants.VarArrayHighBound

Returns high bound for a dimension in a Variant array.

System.Variants.VarArrayLock

Locks a Variant array and returns a pointer to the data.

System.Variants.VarArrayLowBound

Returns the low bound of a dimension in a Variant array.

System.Variants.VarArrayOf

Creates and fills a one-dimensional Variant array.

System.Variants.VarArrayPut

Sets the value of a single cell in a multi-dimensional Variant array.

System.VarArrayRedim

Resizes a Variant array.

System.Variants.VarArrayRef

Returns a reference to the specified Variant array.

System.Variants.VarArrayUnlock

Unlocks a Variant array.

System.VarCmplx.VarAsComplex

Casts an arbitrary Variant so that it is a custom Variant representing a complex number.

System.VarConv.VarAsConvert

Casts an arbitrary Variant so that it is a custom Variant representing a measurement.

System.Variants.VarAsError

Converts a HRESULT into an Error Variant.

System.Variants.VarAsType

Converts a Variant to specified type.

System.VarCast

Converts a variant to specified type.

System.Variants.VarCastError

Raises an System.Variants.EVariantTypeCastError exception.

System.Variants.VarCheckEmpty

Raises an exception if a specified Variant's value is System.Variants.Unassigned.

System.VarClear

Empties a Variant, so that it is unassigned.

System.VarCopy

Copies a Variant to another Variant.

System.Variants.VarCompareValue

Returns the relationship between Variants.

System.VarCmplx.VarComplex

Returns the Variant type code for custom Variants that represent complex numbers.

System.VarCmplx.VarComplexAbs

Returns the absolute value of a complex number.

System.VarCmplx.VarComplexAbsSqr

Returns the square of the absolute value of a complex number.

System.VarCmplx.VarComplexAngle

Returns the angle made by a complex number.

System.VarCmplx.VarComplexArcCos

Returns the inverse cosine of a complex number.

System.VarCmplx.VarComplexArcCosH

Returns the hyperbolic inverse cosine of a complex number.

System.VarCmplx.VarComplexArcCot

Returns the inverse cotangent of a complex number.

System.VarCmplx.VarComplexArcCotH

Returns the hyperbolic inverse cotangent of a complex number.

System.VarCmplx.VarComplexArcCsc

Returns the inverse cosecant of a complex number.

System.VarCmplx.VarComplexArcCscH

Returns the hyperbolic inverse cosecant of a complex number.

System.VarCmplx.VarComplexArcSec

Returns the inverse secant of a complex number.

System.VarCmplx.VarComplexArcSecH

Returns the hyperbolic inverse secant of a complex number.

System.VarCmplx.VarComplexArcSin

Returns the inverse sine of a complex number.

System.VarCmplx.VarComplexArcSinH

Returns the hyperbolic inverse sine of a complex number.

System.VarCmplx.VarComplexArcTan

Returns the inverse tangent of a complex number.

System.VarCmplx.VarComplexArcTanH

Returns the hyperbolic inverse tangent of a complex number.

System.VarCmplx.VarComplexConjugate

Returns the conjugate of a complex number.

System.VarCmplx.VarComplexCos

Returns the cosine of a complex number.

System.VarCmplx.VarComplexCosH

Returns the hyperbolic cosine of a complex number.

System.VarCmplx.VarComplexCot

Returns the cotangent of a complex number.

System.VarCmplx.VarComplexCotH

Returns the hyperbolic cotangent of a complex number.

System.VarCmplx.VarComplexCreate

Returns a custom Variant that represents a complex number.

System.VarCmplx.VarComplexCsc

Returns the cosecant of a complex number.

System.VarCmplx.VarComplexCscH

Returns the hyperbolic cosecant of a complex number.

System.VarCmplx.VarComplexExp

Returns the exponential of a complex number.

System.VarCmplx.VarComplexFromPolar

Converts a set of polar coordinates to a complex number.

System.VarCmplx.VarComplexInverse

Returns the inverse of a complex number.

System.VarCmplx.VarComplexLn

Returns the natural log of a complex number.

System.VarCmplx.VarComplexLog10

Returns the log base 10 of a complex number.

System.VarCmplx.VarComplexLog2

Returns the log base 2 of a complex number.

System.VarCmplx.VarComplexLogN

Returns the log base N of a complex number.

System.VarCmplx.VarComplexPower

Returns the value of a complex number raised to a specified power.

System.VarCmplx.VarComplexSec

Returns the secant of a complex number.

System.VarCmplx.VarComplexSecH

Returns the hyperbolic secant of a complex number.

System.VarCmplx.VarComplexSimplify

Reduces a Variant that represents a complex number to one that represents a real value, if possible.

System.VarCmplx.VarComplexSin

Returns the sine of a complex number.

System.VarCmplx.VarComplexSinH

Returns the hyperbolic sine of a complex number.

System.VarCmplx.VarComplexSqr

Returns the square of a complex number.

System.VarCmplx.VarComplexSqrt

Returns the square root of a complex number.

System.VarCmplx.VarComplexTan

Returns the tangent of a complex number.

System.VarCmplx.VarComplexTanH

Returns the hyperbolic tangent of a complex number.

System.VarCmplx.VarComplexTimesImaginary

Returns the value of a complex number multiplied by an imaginary number.

System.VarCmplx.VarComplexTimesNegI

Returns the value of a complex number multiplied by -i.

System.VarCmplx.VarComplexTimesPosI

Returns the value of a complex number multiplied by i.

System.VarCmplx.VarComplexTimesReal

Returns the value of a complex number multiplied by a real number.

System.VarCmplx.VarComplexToPolar

Computes the polar coordinates that correspond to a custom Variant that represents a complex number.

System.VarConv.VarConvert

Returns the variant type code for custom Variants that represent measurements.

System.VarConv.VarConvertCreate

Returns a custom Variant that represents a measurement.

System.Variants.VarCopyNoInd

Copies a Variant.

System.Variants.VarEnsureRange

Returns a Variant with a value in a specified range.

Data.FmtBcd.VarFMTBcd

Returns the TVarType constant that identifies the internal type of a Variant as a FMTBcd.TBcd value.

Data.FmtBcd.VarFMTBcdCreate

Creates a new Variant that stores its value internally as a FMTBcd.TBcd value.

System.Variants.VarFromDateTime

Returns a Variant containing a specified data and time.

System.Variants.VarInRange

Indicates whether a Variant's value is in a specified range.

System.Variants.VarInvalidNullOp

Indicate Variant operation on null.

System.Variants.VarInvalidOp

Indicate invalid Variant operation.

System.Variants.VarIsArray

Indicates whether the specified Variant is an array.

System.Variants.VarIsByRef

Indicates whether the specified Variant's value is by reference.

System.Variants.VarIsClear]

Indicates whether the specified Variant has an undefined value.

System.VarCmplx.VarIsComplex

Indicates whether a Variant stores its data internally as a complex number.

System.VarConv.VarIsConvert

Indicates whether a Variant is a custom Variant that represents a measurement.

System.Variants.VarIsCustom

Indicates whether the specified Variant is a custom Variant.

System.Variants.VarIsEmpty

Indicates whether the specified Variant is unassigned.

System.Variants.VarIsEmptyParam

Indicates whether the specified Variant represents an unassigned optional parameter.

System.Variants.VarIsError

Indicates whether the specified Variant is an error Variant; optionally converts Variant back to HRESULT.

Data.FmtBcd.VarIsFMTBcd

Indicates whether a specified Variant represents a FMTBcd.TBcd value.

System.Variants.VarIsFloat

Indicates whether the specified Variant represents a floating-point value.

System.Variants.VarIsNull

Indicates whether the specified Variant is System.Variants.Null.

System.Variants.VarIsNumeric

Indicates whether the specified Variant represents a numeric value.

System.Variants.VarIsOrdinal

Indicates whether the specified Variant represents an ordinal value.

System.Variants.VarIsStr

Indicates whether the specified Variant represents a string value.

System.Variants.VarIsType

Indicates whether the specified Variant represents a specified type.

System.Variants.VarOverflowError

Raises an System.Variants.EVariantOverflowError exception.

System.Variants.VarRangeCheckError

Raises an System.Variants.EVariantRangeCheckError exception.

System.Variants.VarResultCheck

Raises Variant exception based on HRESULT value.

System.Variants.VarSameValue

Indicates whether two Variants have equivalent values.

System.Variants.VarSupports

Indicates whether the Variant's value is an interface that supports a specified interface.

Data.FmtBcd.VarToBcd

Converts a Variant into a FMTBcd.TBcd type.

System.Variants.VarToDateTime

Converts a specified Variant to a TDateTime value.

System.Variants.VarToStr

Converts a Variant's value to a string.

System.Variants.VarToStrDef

Converts a Variant's value to a string.

System.Variants.VarToWideStr

Converts a Variant's value to a WideString.

System.Variants.VarToWideStrDef

Converts a Variant's value to a WideString.

System.Variants.VarType

Returns the type code of a specified Variant.

System.Variants.VarTypeAsText

Returns Variant type descriptive string.

System.Variants.VarTypeIsValidArrayType

Indicates whether a Variant type code represents a type that can be used for the elements in a Variant array.

System.Variants.VarTypeIsValidElementType

Indicates whether a Variant type code represents a type that can be used for the elements in a Variant array.

System.Internal.VarHlpr.VariantAdd

Adds two Variants.

System.Internal.VarHlpr.VariantAdd2

Adds two Variants.

System.Internal.VarHlpr.VariantAnd

Performs an and operation between two Variant values.

System.Internal.VarHlpr.VariantAnd2

Performs an and operation between two Variants.

System.Internal.VarHlpr.VariantArrayRedim

Resizes a Variant array.

System.Internal.VarHlpr.VariantCast

Performs a type-cast on a Variant.

System.Internal.VarHlpr.VariantClear

Empties a Variant, so that it is unassigned.

System.Internal.VarHlpr.VariantCpy

Copies a Variant.

System.Internal.VarHlpr.VariantDiv

Divides two Variants.

System.Internal.VarHlpr.VariantDiv2

Divides two Variants.

System.Internal.VarHlpr.VariantFromUnicodeString

Assigns an Unicode string to a Variant.

System.Internal.VarHlpr.VariantGetElement

Returns an element from a Variant array.

System.Internal.VarHlpr.VariantMod

Returns the remainder on division of two Variants.

System.Internal.VarHlpr.VariantMod2

Returns the remainder on division of two Variants.

System.Internal.VarHlpr.VariantMul

Multiplies two Variants.

System.Internal.VarHlpr.VariantMul2

Multiplies two Variants.

System.Internal.VarHlpr.VariantNeg

Inverts the sign of a Variant.

System.Internal.VarHlpr.VariantNot

Performs a not operation on a Variant.

System.Internal.VarHlpr.VariantOr

Performs an or operation between two Variants.

System.Internal.VarHlpr.VariantOr2

Performs an or operation between two Variants.

System.Internal.VarHlpr.VariantPutElement

Sets the value of an element in a Variant array.

System.Internal.VarHlpr.VariantShl

Performs an shl (shift left) operation between two Variants.

System.Internal.VarHlpr.VariantShl2

Performs an shl (shift left) operation between two Variants.

System.Internal.VarHlpr.VariantShr

Performs an shr (shift right) operation between two Variants.

System.Internal.VarHlpr.VariantShr2

Performs an shr (shift right) operation between two Variants.

System.Internal.VarHlpr.VariantSub

Subtracts two Variants.

System.Internal.VarHlpr.VariantSub2

Subtracts two Variants.

System.Internal.VarHlpr.VariantToUnicodeString

Converts a Variant to an Unicode string.

System.Internal.VarHlpr.VariantXor

Performs a xor (exclusive or) operation between two Variants.

System.Internal.VarHlpr.VariantXor2

Performs a xor (exclusive or) operation between two Variants.



See Also