Attach elements to an existing Mark-Up as corrected or highlighted elements.
GSErrCode ACAPI_MarkUp_AttachElements ( const API_Guid& markUpGuid, const GS::Array<API_Guid>& elemList, API_MarkUpComponentTypeID type, GS::HashTable<API_Guid, API_Guid>* modificationElemTable = nullptr );
- [in] GUID of the existing Mark-Up.
- [in] The list of elements to attach.
- [in] Attach the elements with the given Component type.
- [in/out] Optional parameter, used only when
APIMarkUpComponent_Modificationis passed in
typeparameter. The table of the original and the modified element pairs.
If the given table does not contain the element as key, then a new element will be created as the modified pair. But if the table already contains the element, then the pair in the table will be set as the modified element.
- The function has completed with success.
- The function must be undoable, it wasn’t called from an undoable command scope.
- The passed
markUpGuidparameter or at least one of the given element GUIDs was incorrect.
For other common API errors see the API Errors document.
Using this function an existing element can be attached to an existing Mark-Up entry.
Note that an element can be attached to only one Mark-Up as creation or deletion, but it can be attached to more Mark-Ups as highlighted and cannot be attached as highlighted and creation/deletion simultaneously. If the requested attachment would violate these rules than
APIERR_BADPARS error code will be returned.
Use ACAPI_MarkUp_GetAttachedElements function to return the already attached elements of the Mark-Up entry and ACAPI_MarkUp_DetachElements function to detach previously added elements.
Mark-Up related code samples can be found in the MarkUp_Manager example add-on.
- Version: API 21 or later
- Header: ACAPinc.h
ACAPI_MarkUp_GetList, ACAPI_MarkUp_GetAttachedElements, ACAPI_MarkUp_DetachElements