Admin Production ni-theme
Current Publication

CA_VariantGetType

LabWindows/CVI

CA_VariantGetType

unsigned int CA_VariantGetType (const VARIANT *variant);

Purpose

Determines the type of value the specified variant contains.

Parameters

Input
Name Type Description
variant const VARIANT * Pointer to the variant variable to inspect.

Return Value

Name Type Description
type unsigned int Returns one of the following values:

0 The Variant parameter is not valid.
CAVT_EMPTYContains no value.
CAVT_NULLContains CAVT_NULL
CAVT_SHORT Contains a short
CAVT_LONG Contains a long
CAVT_INT Contains an int (same as CAVT_LONG
CAVT_FLOAT Contains a float
CAVT_DOUBLE Contains a double
CAVT_CY Contains a CURRENCY
CAVT_DATE Contains a DATE
CAVT_BSTR Contains a BSTR
CAVT_DISPATCH Contains an LPDISPATCH
CAVT_ERROR Contains an SCODE
CAVT_BOOL Contains a VBOOL
CAVT_UNKNOWN Contains an IUnknown interface
CAVT_UCHAR Contains an unsigned char
CAVT_CHAR Contains a char
CAVT_USHORT Contains an unsigned short
CAVT_ULONG Contains an unsigned long
CAVT_UINT Contains an unsigned int
CAVT_LONGLONG Contains a long long
CAVT_ULONGLONG Contains an unsigned long long
CAVT_CSTRING Contains a string
CAVT_OBJHANDLE Contains a IDispatch interface

If the variant contains a pointer, this function returns the CAVT_BYREF flag OR'ed in with one of the following values. If the variant is a pointer to an array, the CAVT_ARRAY flag is also OR'ed into the value.

CAVT_SHORT
CAVT_LONG
CAVT_FLOAT
CAVT_DOUBLE
CAVT_CY
CAVT_DATE
CAVT_BSTR
CAVT_DISPATCH
CAVT_ERROR
CAVT_BOOL
CAVT_VARIANT
CAVT_UNKNOWN
CAVT_UCHAR
CAVT_CHAR
CAVT_USHORT
CAVT_ULONG
CAVT_UINT
CAVT_LONGLONG
CAVT_ULONGLONG


If the variant contains an array, this function returns CAVT_ARRAY OR'ed in with one of the following values:

CAVT_SHORT
CAVT_LONG
CAVT_FLOAT
CAVT_DOUBLE
CAVT_CY
CAVT_DATE
CAVT_CSTRING
CAVT_DISPATCH
CAVT_ERROR
CAVT_BOOL
CAVT_VARIANT
CAVT_UNKNOWN
CAVT_UCHAR
CAVT_CHAR
CAVT_USHORT
CAVT_ULONG
CAVT_UINT
CAVT_LONGLONG
CAVT_ULONGLONG

Additional Information

Library: ActiveX Library

Include file: cviauto.h

LabWindows/CVI compatibility: LabWindows/CVI 5.0 and later