COMVariant.boolean Method

Article
04/11/2014

Gets or sets the value of a COMVariant object of the VT_BOOL data type.

Syntax

public boolean boolean([boolean newValue])

Run On

Called

Parameters

newValue
Type: boolean
The new value; optional.

Return Value

Type: boolean
The current value.

Remarks

If you pass in a value that has a different data type than the object, the data type of the object will be changed to match the data type of the value.

A COMVariant object has a Boolean type if its data type is set to COMVariantType::VT_BOOL.

The COM Boolean data type may also be referred to as "VARIANT_BOOL".

Examples

The following example creates a new COMVariant object of type VT_BOOL and sets the value to true.

{ 
    COMVariant var = new COMVariant( 
        COMVariantInOut::IN_OUT,  
        COMVariantType::VT_BOOL); 
 
    // Set value of the object 
    var.boolean(true); 
}