ACAPI_​MarkUp_​AttachElements

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,
        const bool                     asCorrected
    );

 

Parameters

markUpGuid
[in] GUID of the existing Mark-Up.
elemList
[in] The list of elements to attach.
asCorrected
[in] Add the given elements as corrected (or highlighted).

 

Return Values

NoError
The function has completed with success.
APIERR_NEEDSUNDOSCOPE
The function must be undoable, it wasn’t called from an undoable command scope.
APIERR_BADPARS
The passed markUpGuid parameter or at least one of the given element GUIDs was incorrect.

For other common API errors see the API Errors document.

 

Remarks

Using this function an existing element can be attached to an existing Mark-Up entry as corrected or highlighted element.
Note that an element can be attached to only one Mark-Up as corrected, but it can be attached to more Mark-Ups as highlighted and cannot be corrected and highlighted 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.

 

Example

Mark-Up related code samples can be found in the MarkUp_Manager example add-on.

 

Requirements

Version: API 21 or later
Header: ACAPinc.h

 

See Also

API_MarkUpType
ACAPI_MarkUp_GetList, ACAPI_MarkUp_GetAttachedElements, ACAPI_MarkUp_DetachElements
API Functions