VarUtils Namespace

This is namespace VarUtils.

Name	Description
Classes	The following table lists classes in this documentation.
Functions	The following table lists functions in this documentation.
Structs, Records, Enums	The following table lists structs, records, enums in this documentation.
Variables	The following table lists variables in this documentation.
Constants	The following table lists constants in this documentation.

Classes

	Name	Description
	ESafeArrayBoundsError	ESafeArrayBoundsError is the exception class for errors that occur because a variant array index is out of bounds.
	ESafeArrayCreateError	ESafeArrayCreateError is the exception class for failing to create a variant array.
	ESafeArrayError	ESafeArrayError is the exception class for errors involving variant arrays.
	ESafeArrayLockedError	ESafeArrayLockedError is the exception class for errors that occur because a variant array is locked or fixed.

Constants

Name	Description
ARR_DISPATCH	Used to test whether the variant array contains IDispatch elements.
ARR_FIXEDSIZE	Used to test whether the variant array is of fixed size.
ARR_NONE	Specifies that a variant array has no flags set.
ARR_OLESTR	Used to test whether the variant array contains BSTR elements.
ARR_UNKNOWN	Used to test whether the variant array contains IUnknown elements.
ARR_VARIANT	Used to test whether the variant array contains Variant elements.
CMaxArrayVarType	CMaxArrayVarType gives the upper bound of the CVarTypeToElementInfo array.
CMinArrayVarType	CMinArrayVarType gives the lower bound of the CVarTypeToElementInfo array.
CVarTypeToElementInfo	This constant is internally used by the SafeArrayCreate function.
GenericOperations	Specifies whether the implementation for the variant operation routines is cross-platform.
GenericSafeArrays	Specifies whether the implementation for the safe array routines is cross-platform.
GenericSafeArrayUsesLibC	Specifies whether the implementation for the safe array routines uses the Libc unit.
GenericVariants	Specifies whether the implementation for the variant support routines is cross-platform.
GenericVarUtils	Specifies whether the implementation for the variant-manipulating routines is cross-platform.
VAR_ARRAYISLOCKED	Specifies that the given array is locked.
VAR_BADINDEX	Indicates that the given index is out of range.
VAR_BADVARTYPE	Specifies that the variant type of the input parameter is invalid.
VAR_CMP_EQ	VAR_CMP_EQ specifies that the variants are equal, after a call to the function referenced by the VarCmp variable.
VAR_CMP_GT	VAR_CMP_GT specifies that the first variant is greater than the second, after a call to the function referenced by the VarCmp variable.
VAR_CMP_LT	VAR_CMP_LT specifies that the first variant is lower than the second, after a call to the function referenced by the VarCmp variable.
VAR_CMP_NULL	VAR_CMP_NULL specifies that either one of the variants is nil, after a call to the function referenced by the VarCmp variable.
VAR_EXCEPTION	Specifies that the application raised an exception.
VAR_INVALIDARG	Specifies that either one of the arguments is invalid.
VAR_LOCALE_USER_DEFAULT	Specifies the default locale for the user or process.
VAR_NOTIMPL	Specifies that the operation is not implemented.
VAR_OK	Specifies that a variant operation was successful.
VAR_OUTOFMEMORY	Specifies that there is not enough memory to complete the operation.
VAR_OVERFLOW	Specifies that a variant operation caused an overflow.
VAR_PARAMNOTFOUND	Indicates that there is no correspondence between the parameter DISPIDs and a parameter of the method.
VAR_TYPEMISMATCH	Specifies that the argument cannot be cast to the specified type.
VAR_UNEXPECTED	Indicates that an unexpected error occurred.

Functions

	Name	Description
	SafeArrayAccessData	Returns a pointer to the actual safe array data and locks the safe array.
	SafeArrayAllocData	Allocates the actual data of the given safe array.
	SafeArrayAllocDescriptor	Allocates a descriptor for the safe array.
	SafeArrayCheck	Checks whether the given parameter is a safe array operation error code.
	SafeArrayCopy	Copies a safe array to another.
	SafeArrayCopyData	Copies the data from a safe array to another.
	SafeArrayCreate	Creates a safe array.
	SafeArrayDestroy	Destroys a safe array.
	SafeArrayDestroyData	Destroys the actual data of the given safe array.
	SafeArrayDestroyDescriptor	Destroys the descriptor of the given safe array.
	SafeArrayError	Raises an event corresponding to the given safe array operation error code.
	SafeArrayGetDim	Returns the number of dimension of the given safe array.
	SafeArrayGetElement	Returns the element at the specified position in the given safe array.
	SafeArrayGetElemSize	Returns the size in bytes of an element in the given safe array.
	SafeArrayGetLBound	Returns the lower bound for the given dimension of a safe array.
	SafeArrayGetUBound	Returns the upper bound for the given dimension of a safe array.
	SafeArrayLock	Locks a safe array.
	SafeArrayPtrOfIndex	Returns a pointer to the element at the specified position in the given safe array.
	SafeArrayPutElement	Sets the element at the specified position in the given safe array.
	SafeArrayRedim	Changes the bound information for the last dimension of a safe array.
	SafeArrayUnaccessData	Unlocks a safe array previously locked using the SafeArrayAccessData routine.
	SafeArrayUnlock	Unlocks a safe array.
	VarExceptionToResult	Converts an Exception type argument to an HRESULT type.
	VariantChangeType	Converts a variant from one type to another.
	VariantClear	Clears a variant.
	VariantCopy	Clears the destination variant and makes a copy of the source variant.
	VariantCopyInd	Clears the destination variant and makes a copy of the source variant, including the case when the source is of varByRef type.
	VariantInit	Initializes a variant.

Structs, Records, Enums

	Name	Description
	TVarTypeToElementInfo	This is an internal record type used in declaring the CVarTypeToElementInfo constant array.

Variables

Name	Description
VarAdd	VarAdd is a function type variable that specifies the function making the addition operation between two variants.
VarAnd	VarAnd is a function type variable that specifies the function making the bitwise and operation between two variants.
VarBoolFromStr	VarBoolFromStr is used to specify the function that makes the conversion from a WideString to a boolean value.
VarBstrFromBool	VarBstrFromBool is used to specify the function that makes the conversion from a boolean value to a WideString.
VarBstrFromCy	VarBstrFromCy is used to specify the function that makes the conversion from a currency value to a WideString.
VarBstrFromDate	VarBstrFromDate is used to specify the function that makes the conversion from a date value to a WideString.
VarCmp	VarCmp is a variable used to specify the function that compares two variants.
VarCyFromStr	VarCyFromStr is used to specify the function that makes the conversion from a WideString to a currency value.
VarDateFromStr	VarDateFromStr is used to specify the function that makes the conversion from a WideString to a date value.
VarDiv	VarDiv is a function type variable that specifies the function making the division operation between two variants.
VarI4FromStr	VarI4FromStr is used to specify the function that makes the conversion from a WideString to a four bytes integer value.
VariantChangeTypeEx	VariantChangeTypeEx stores the function that converts a variant from one type to another, using locale-specific information.
VarIDiv	VarIDiv is a function type variable that specifies the function making the division operation between two variants, after converting the variants to integers.
VarMod	VarMod is a function type variable that specifies the function that calculates the remainder on division of two variants.
VarMul	VarMul is a function type variable that specifies the function making the multiplication operation between two variants.
VarNeg	VarNeg is a function type variable that specifies the function that inverts the sign of a variant.
VarNot	VarNot is a function type variable that specifies the function that performs a not operation on a variant.
VarOr	VarOr is a function type variable that specifies the function doing the bitwise or operation between two variants.
VarR4FromStr	VarR4FromStr is used to specify the function that does the conversion from a WideString to a four bytes floating-point value.
VarR8FromStr	VarR8FromStr is used to specify the function that makes the conversion from a WideString to a eight bytes floating-point value.
VarSub	VarSub is a function type variable that specifies the function making the subtraction operation between two variants.
VarXor	VarXor is a function type variable that specifies the function making the bitwise xor (exclusive or) operation between two variants.

What do you think about this topic? Send feedback!