Sets the specified property to the given value on an element default.
GSErrCode ACAPI_Element_SetPropertyOfDefaultElem ( API_ElemTypeID typeID, API_ElemVariationID variationID, const API_Property& property );
Parameters
- typeID
- [in] Type of the default element.
- variationID
- [in] The element variation that distinguishes between the element kinds of the same type.
- property
- [in] Specifies the property to be set.
Return Values
NoError
- The function has completed with success.
APIERR_BADID
- Incorrect
typeID
orvariationID
was specified or one of the property definitions’ guid did not refer to a valid object. APIERR_NOACCESSRIGHT
- The current user does not have the right to modify the properties of the specified element on a teamwork server.
APIERR_READONLY
- Tried to modify a read-only property (for example a property coming from a hotlink).
APIERR_BADPROPERTY
- The property definition is not available for the given element.
For other common API errors see the API Errors document.
Example
For more detailed examples, please see the Property_Test add-on.GSErrCode SetFirstPropertyValueToDefault (API_ElemTypeID typeId, API_ElemVariationID variationID) { 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) { API_Property property = properties[0]; property.isDefault = true; error = ACAPI_Element_SetPropertyOfDefaultElem (typeId, variationID, property); } } return error; }
Requirements
- Version: API 22 or later
- Header: ACAPinc.h