Deletes an existing Mark-Up entry.
GSErrCode ACAPI_MarkUp_Delete ( const API_Guid& markUpGuid, const bool keepCorrectedElems = true );
Parameters
- markUpGuid
- [in] GUID of the existing Mark-Up.
- keepCorrectedElems
- [in] Keep or delete the attached corrected elements.
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
markUp.guid
parameter was incorrect.
For other common API errors see the API Errors document.
Remarks
Use this function to delete an existing Mark-Up entry.
If the Mark-Up has any attached corrected element, then depending on the value of the keepCorrectedElems
parameter, the correncted elements will be deleted or kept after the deletion of the owner Mark-Up.
Use ACAPI_MarkUp_Create function to create and ACAPI_MarkUp_Delete function to delete Mark-Up entry.
Use ACAPI_MarkUp_GetAttachedElements function to return the attached elements of the Mark-Up entry.
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_Create, ACAPI_MarkUp_Change
API Functions