API_​PropertyValue

A container for storing a property’s value.

    typedef struct {
        API_SingleVariant                  singleVariant;
        API_ListVariant                    listVariant;
        API_SingleEnumerationVariant       singleEnumVariant;
        API_MultipleEnumerationVariant     multipleEnumVariant;
        API_VariantStatus                  variantStatus;
    } API_PropertyValue;
    

 

Members

singleVariant
The value of the property if the definition’s collectionType is API_PropertySingleCollectionType.
listVariant
The value of the property if the definition’s collectionType is API_PropertyListCollectionType.
singleEnumVariant
The value of the property if the definition’s collectionType is API_PropertySingleChoiceEnumerationCollectionType.
multipleEnumVariant
The value of the property if the definition’s collectionType is API_PropertyMultipleChoiceEnumerationCollectionType.
variantStatusAPI 22
The status of the property’s currently valid value. If the status is not set to APIVariantStatusNormal, the property value is ignored.

 

Requirements

Version: API 20 or later
Header: APIdefs_Properties.h

 

See Also

API_PropertyDefinition
API_Property
Properties