Category 3D drawings and annotations, Object ProAnnotationelem

Function ProAnnotationelemReferencesCollect


Description
Gets the references contained in an annotation element.
Licensing Requirement
TOOLKIT for 3D Drawings
Synopsis
#include <ProAnnotationElem.h>
ProErrorProAnnotationelemReferencesCollect(
ProAnnotationElem* element
/* (In)
The annotation element.
*/
ProAnnotationRefFilter ref_type
/* (In)
The type of references to collect (weak, strong, or all).
*/
ProAnnotationRefFromType source
/* (In)
The source of the references (from the annotation, from the user, or all).
*/
ProAnnotationReference** references
/* (Out)
The annotation references. Free this using ProAnnotationreferencearrayFree().
*/
)
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 any references of the indicated type.
PRO_TK_INVALID_TYPEReferences from driving dimension annotation elements cannot be accessed.

Manual References:

  1. Annotations: Annotation Features and Annotations: Accessing Annotation Elements
  2. Annotations: Annotation Features and Annotations: Accessing Annotation Elements

Sample Code References:

  1. pt_af_examples ( PTAEToChamfer.c )
  2. pt_af_examples ( PTAEToDraft.c )
  3. pt_af_examples ( PTAEToRound.c )