Category Drawings and detail, Object ProDtlnote

Function ProDtlnoteCreate


Description
Creates a note.
Replacement in Object TOOLKIT: pfcDetailItemOwner::CreateDetailItem
pfcDetailSymbolDefItem::CreateDetailItem
Synopsis
#include <ProDtlnote.h>
ProErrorProDtlnoteCreate(
ProMdl owner
/* (In)
The owner handle.
*/
ProDtlsymdef* symbol
/* (In)
If you are adding a note to the drawing, set the symbol to NULL. If you are adding a note to a symbol definition, set the symbol to be that symbol definition.
*/
ProDtlnotedata notedata
/* (In)
The note data.
*/
ProDtlnote* note
/* (Out)
Created note.
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully created the note.
PRO_TK_BAD_INPUTSOne or more arguments was invalid.
PRO_TK_GENERAL_ERRORThe note could not be created.

Manual References:

  1. Drawings: Creating, Modifying and Reading Detail Items
  2. Drawings: Detail Note Data
  3. Drawings: Creating a Symbol Definition

Sample Code References:

  1. pt_examples ( TestDtlnote.c )
  2. pt_examples ( TestSymDefMenu.c )
  3. pt_userguide ( UgDtlnoteExamples.c )
  4. pt_userguide ( UgDtlsymdefExamples.c )
  5. pt_userguide ( UgNoteCreate.c )