ACAPI_​Element_​GetPropertyValuesOfDefaultElem

Retrieves the values of the specified property definitions.

    GSErrCode  ACAPI_Element_GetPropertyValuesOfDefaultElem (
        API_ElemTypeID                               typeID,
        API_ElemVariationID                          variationID,
        const GS::Array<API_PropertyDefinition>&     propertyDefinitions,
        GS::Array<API_Property>&                     properties
    );

 

Parameters

typeID
[in] Type of the default element.
variationID
[in] The element variation that distinguishes the element kinds of the same type.
propertyDefinitions
[in] The property definitions (identified by definition.guid) to get the values for.
properties
[out] The definitions and values of the requested properties.

 

Return Values

NoError
The function has completed with success.
APIERR_BADID
Incorrect typeID or variationID was specified.

For other common API errors see the API Errors document.

 

Example



GSErrCode GetAllPropertyValues (API_ElemTypeID typeId, API_ElemVariationID variationID, GS::Array<API_PropertyValue>& values)
{
    GS::Array<API_PropertyDefinition> definitions;
    GSErrCode error = ACAPI_Element_GetPropertyDefinitionsOfDefaultElem (typeId, variationID, API_PropertyDefinitionFilter_UserDefined, definitions);
    if (error == NoError) {
        GS::Array<API_Property> properties;
        error = ACAPI_Element_GetPropertyValuesOfDefaultElem (typeId, variationID, definitions, properties);
        if (error == NoError) {
            for (UInt32 i = 0; i < properties.GetSize (); i++) {
                if (properties[i].isDefault) {
                    values.Push (properties[i].definition.defaultValue);
                } else {
                    values.Push (properties[i].value);
                }
            }
        }
    }

    return error;
}

        
For more detailed examples, please see the Property_Test add-on.

 

Requirements

Version: API 22 or later
Header: ACAPinc.h

 

See Also

Properties,
API Functions