Category Drawings and detail, Object ProDrawing

Function ProDrawingSheetDelete


Description
Deletes the specified sheet from a drawing-type model. The valid drawing-type models are as follows: Notebook, Format, Drawing, Diagram, Report.
Replacement in Object TOOLKIT: pfcSheetOwner::DeleteSheet
Synopsis
#include <ProDrawing.h>
ProErrorProDrawingSheetDelete(
ProDrawing drawing
/* (In)
The drawing-type model
*/
int sheet
/* (In)
The number of the sheet to delete
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully deleted the drawing sheet.
PRO_TK_GENERAL_ERRORThe function failed because of an internal error.
PRO_TK_BAD_INPUTThe function failed because one or more of the input arguments are invalid.
PRO_TK_E_NOT_FOUNDThe function failed because you do not have the required modules.
PRO_TK_INVALID_ITEMThe function did nothing because the specified sheet is not in the specified drawing.
PRO_TK_E_DEADLOCKThe Creo Parametric user interface is not prepared to handle this request (because it is blocked by another process such as an OLE container activation).

Manual References:

  1. Drawings: Drawing Sheets
  2. Drawings: Drawing Sheets

Sample Code References:

  1. pt_examples ( TestDrwSheets.c )
  2. pt_userguide ( UgSheetDelete.c )