Category Drawings and detail, Object ProDrawing

Function ProDrawingDtlnotesCollect


Description
Collect notes in the specified drawing.
Replacement in Object TOOLKIT: pfcDetailItemOwner::ListDetailItems
pfcDetailItemOwner::GetDetailItem
pfcDetailSymbolDefItem::GetDetailItem
pfcDetailSymbolDefItem::ListDetailItems
Synopsis
#include <ProDtlnote.h>
ProErrorProDrawingDtlnotesCollect(
ProDrawing drawing
/* (In)
The drawing handle.
*/
ProDtlsymdef* symbol
/* (In)
If you are collecting a note from the drawing, set the symbol to NULL. If you are collecting a note from a symbol definition, set the symbol to be that symbol definition.
*/
int sheet
/* (In)
The sheet number. Set to PRO_VALUE_UNUSED for current sheet.
*/
ProDtlnote** notes
/* (Out)
The ProArray of notes. The function allocates memory for array. User must release memory by ProArrayFree.
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully collected the notes.
PRO_TK_BAD_INPUTSOne or more arguments was invalid.
PRO_TK_GENERAL_ERRORThe function failed.
PRO_TK_OUT_OF_MEMORYThe function found too many entities to be contained in the output ProArray. Use ProDrawingDtlnoteVisit instead.
PRO_TK_E_NOT_FOUNDNo notes were found.

Manual References:

  1. Drawings: Listing Detail Items
  2. Drawings: Listing Detail Items

Sample Code References:

  1. pt_examples ( TestDtlnote.c )
  2. pt_examples ( TestDtlsyminst.c )
  3. pt_examples ( TestSymDefInfo.c )
  4. pt_userguide ( UgNotesColor.c )