Admin Production ni-theme
Current Publication

CA_DefaultValueVariant

LabWindows/CVI

CA_DefaultValueVariant

VARIANT CA_DefaultValueVariant (void);

Purpose

Some ActiveX server functions allow you to pass a variant parameter value that means "use the default value for this parameter." CA_DefaultValueVariant returns such a variant. You can use the macro CA_DEFAULT_VAL to refer to CA_DefaultValueVariant.

You can use the returned variant only for parameters that are optional. You can tell whether a parameter is optional by checking the default value in its function panel control. If the default value is CA_DEFAULT_VAL, the parameter is optional.

CA_DefaultValueVariant sets the type field in the returned variant to VT_ERROR and the error value field to DISP_E_PARAMNOTFOUND.

Parameters

None.

Return Value

Name Type Description
variant VARIANT Variant in which the type field is set to VT_ERROR and the error value is set to DISP_E_PARAMNOTFOUND.

Additional Information

Library: ActiveX Library

Include file: cviauto.h

LabWindows/CVI compatibility: LabWindows/CVI 5.0 and later