Category 3D drawings and annotations, Object ProAnnotationelem

Function ProAnnotationelemReferenceRemove


Description
Removes a user-added reference from the annotation element.
Licensing Requirement
TOOLKIT for 3D Drawings
Synopsis
#include <ProAnnotationElem.h>
ProErrorProAnnotationelemReferenceRemove(
ProSelection element
/* (In)
The annotation element. If the annotation element belongs to an assembly, component path must be specified.
*/
ProBoolean allow_fix_ui
/* (In)
PRO_B_TRUE to bring up the Fix Model UI in the event of regeneration failure; PRO_B_FALSE to abort the reference removal.
*/
ProAnnotationReference* reference
/* (In)
The reference to remove.
*/
)
Returns
PRO_TK_NO_ERRORThe function succeeded.
PRO_TK_BAD_INPUTSOne or more inputs was invalid.
PRO_TK_E_NOT_FOUNDThe annotation element does not contain this reference.
PRO_TK_BAD_CONTEXTThis reference is provided from the annotation and cannot be removed.
PRO_TK_UNATTACHED_FEATSRemoval was aborted due to regeneration failure.

Manual References:

  1. Annotations: Annotation Features and Annotations: Modification of Annotation Elements
  2. Annotations: Annotation Features and Annotations: Modification of Annotation Elements