Deletes an existing Mark-Up entry.
GSErrCode ACAPI_MarkUp_Delete ( const API_Guid& markUpGuid, const bool keepCorrectedElems = true );
- [in] GUID of the existing Mark-Up.
- [in] Keep or delete the attached corrected elements.
- The function has completed with success.
- The function must be undoable, it wasn’t called from an undoable command scope.
- The passed
markUp.guidparameter was incorrect.
For other common API errors see the API Errors document.
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.
Mark-Up related code samples can be found in the MarkUp_Manager example add-on.
- Version: API 21 or later
- Header: ACAPinc.h