IPXC_Pages::DeletePages Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
Line 7: Line 7:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT DeletePages([in]                      IBitSet*            pIndexes,
+
<pre class="brush:cpp;gutter:false">HRESULT DeletePages([in]                      IBitSet*            Indexes,
                     [in, defaultvalue(NULL)]  IProgressMon*        pProgress,
+
                     [in, defaultvalue(NULL)]  IProgressMon*        Progress,
                     [out, defaultvalue(NULL)]  IPXC_UndoRedoData**  pUndoData);</pre>
+
                     [out, defaultvalue(NULL)]  IPXC_UndoRedoData**  UndoData);</pre>
  
 
== Parameters ==
 
== Parameters ==
;pIndexes
+
;Indexes
 
:[in]  Pointer to [[PXV:IBitSet|IBitSet]] containing the indexes of pages that need to be deleted. Note that the [[PXV:IAUX_Inst_CreateBitSet|IAUX_Inst::CreateBitSet]] method should be used to create a bit set.
 
:[in]  Pointer to [[PXV:IBitSet|IBitSet]] containing the indexes of pages that need to be deleted. Note that the [[PXV:IAUX_Inst_CreateBitSet|IAUX_Inst::CreateBitSet]] method should be used to create a bit set.
;pProgress
+
;Progress
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IProgressMon|IProgressMon]] containing the progress monitor. Note that the [[PXV:IPXV_Inst_ProgressMon|IPXV_Inst::ProgressMon]] property should be used to get the progress monitor from the [[PXV:IPXV_Inst|instance]].
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IProgressMon|IProgressMon]] containing the progress monitor. Note that the [[PXV:IPXV_Inst_ProgressMon|IPXV_Inst::ProgressMon]] property should be used to get the progress monitor from the [[PXV:IPXV_Inst|instance]].
;pUndoData
+
;UndoData
 
:[out, defaultvalue(NULL)]  Pointer to [[PXV:IPXC_UndoRedoData|IPXC_UndoRedoData]] containing the filled Undo/Redo data if any was given to be filled.
 
:[out, defaultvalue(NULL)]  Pointer to [[PXV:IPXC_UndoRedoData|IPXC_UndoRedoData]] containing the filled Undo/Redo data if any was given to be filled.
  

Revision as of 06:09, 12 June 2015

Removes pages from the core document by indexes.

Syntax

HRESULT DeletePages([in]                       IBitSet*             Indexes,
                    [in, defaultvalue(NULL)]   IProgressMon*        Progress,
                    [out, defaultvalue(NULL)]  IPXC_UndoRedoData**  UndoData);

Parameters

Indexes
[in] Pointer to IBitSet containing the indexes of pages that need to be deleted. Note that the IAUX_Inst::CreateBitSet method should be used to create a bit set.
Progress
[in, defaultvalue(NULL)] Pointer to IProgressMon containing the progress monitor. Note that the IPXV_Inst::ProgressMon property should be used to get the progress monitor from the instance.
UndoData
[out, defaultvalue(NULL)] Pointer to IPXC_UndoRedoData containing the filled Undo/Redo data if any was given to be filled.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IPXC_Pages