Category Drawings and detail, Object ProDtlnote

Function ProDtlnoteDataGet


Description
Gets a note data for the specified note. The function allocates memory; user must release this memory with ProDtlnotedataFree
Replacement in Object TOOLKIT: pfcDetailNoteItem::GetInstructions
Synopsis
#include <ProDtlnote.h>
ProErrorProDtlnoteDataGet(
ProDtlnote* note
/* (In)
The note.
*/
ProDtlsymdef* symbol
/* (In)
If you are getting a note from the drawing, set the symbol to NULL. If you are getting a note from a symbol definition, set the symbol to be that symbol definition.
*/
ProDisplayMode mode
/* (In)
The display mode.

Note:Creo Parametric does not resolve and replace symbolic callouts for notes, which are not displayed. Therefore, for the value PRODISPMODE_NUMERIC, if the note is not displayed or is hidden in a layer, the text retrieved may contain the symbolic callouts.
*/
ProDtlnotedata* notedata
/* (Out)
The note data. Free the data using ProDtlnotedataFree.
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully retrieved the note data.
PRO_TK_BAD_INPUTSOne or more arguments was invalid.
PRO_TK_GENERAL_ERRORThe function failed.

Manual References:

  1. Annotations: Geometric Tolerances: Creating a Geometric Tolerance
  2. Technical Summary of Changes for Creo 4.0 F000: Change in Behavior of ProDtlnoteDataGet()
  3. Drawings: Creating, Modifying and Reading Detail Items
  4. Drawings: Creating, Modifying and Reading Detail Items
  5. Drawings: Detail Note Line Data
  6. Drawings: Detail Note Data
  7. Drawings: Read-Only Notes

Sample Code References:

  1. pt_examples ( TestDtlnote.c )
  2. pt_examples ( TestDtlnote.c )
  3. pt_examples ( TestDtlsyminst.c )
  4. pt_examples ( TestSymDefInfo.c )
  5. pt_examples ( TestSymDefMenu.c )
  6. pt_userguide ( UgNotesColor.c )
  7. pt_userguide ( UgTableColorChange.c )