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)
 
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_Pages::DeletePages Method}}
 
{{#customTitle:IPXC_Pages::DeletePages Method}}
{{#parentPage:PXV:IPXC_Pages|method}}
+
{{#parentPage:PXV:IPXC_Pages#Methods|DeletePages|method}}
{{ToWrite}}
+
{{ToReview}}
+
  
The method of interface of PDF-XChange Editor SDK.
+
Removes pages from the [[PXV:IPXC_Document|core document]] by [[PXV:IBitSet|indexes]].
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT DeletePages([in] IBitSet* pIndexes, [in, defaultvalue(NULL)] IProgressMon* pProgress, [out, defaultvalue(NULL)] IPXC_UndoRedoData** ppUndoData);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT DeletePages([in]                       IBitSet*             pIndexes,
 +
                    [in, defaultvalue(NULL)]   IProgressMon*       pProgress,
 +
                    [out, defaultvalue(NULL)] IPXC_UndoRedoData** pUndoData);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pIndexes''
+
;pIndexes
:[in]  Pointer to [[PXV:IBitSet|IBitSet]].
+
:[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''
+
;pProgress
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IProgressMon|IProgressMon]].
+
:[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]].
;''ppUndoData''
+
;pUndoData
:[out, defaultvalue(NULL)]  Pointer to [[PXV:IPXC_UndoRedoData|IPXC_UndoRedoData]].
+
:[out, defaultvalue(NULL)]  Pointer to [[PXV:IPXC_UndoRedoData|IPXC_UndoRedoData]] containing the filled Undo/Redo data if any was given to be filled.
  
 
== Return Value ==
 
== Return Value ==
Line 22: Line 23:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXC_Pages|IPXC_Pages]].
+
[[PXV:IPXC_Pages|IPXC_Pages]]

Latest revision as of 02:33, 15 June 2015

Removes pages from the core document by indexes.

Syntax

HRESULT DeletePages([in]                       IBitSet*             pIndexes,
                    [in, defaultvalue(NULL)]   IProgressMon*        pProgress,
                    [out, defaultvalue(NULL)]  IPXC_UndoRedoData**  pUndoData);

Parameters

pIndexes
[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.
pProgress
[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.
pUndoData
[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