Category Drawings and detail, Object ProDtlnote

Function ProDtlnoteRemove


Description
Remove a note. Make note in the database disappear on the drawing and continue to disappear after the drawing is regenerated. NOTE: The drawing must be current to use this function; to set a note to be undisplayed in a non-current drawing using ProDtlnotedataDisplayedSet() and regenerate the drawing.
Replacement in Object TOOLKIT: pfcDetailNoteItem::Remove
Synopsis
#include <ProDtlnote.h>
ProErrorProDtlnoteRemove(
ProDtlnote* note
/* (In)
The note.
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully removed the note.
PRO_TK_BAD_INPUTSOne or more arguments was invalid.
PRO_TK_GENERAL_ERRORCan't remove the note.

Manual References:

  1. Drawings: Displaying Detail Items

Sample Code References:

  1. pt_examples ( TestDtlnote.c )
  2. pt_userguide ( UgTableColorChange.c )