IPXC_Pages::DeletePages Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 3: | Line 3: | ||
{{#customTitle:IPXC_Pages::DeletePages Method}} | {{#customTitle:IPXC_Pages::DeletePages Method}} | ||
{{#parentPage:PXV:IPXC_Pages|DeletePages Method|method}} | {{#parentPage:PXV:IPXC_Pages|DeletePages Method|method}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
| − | + | Removes pages from the [[PXV:IPXC_Document|core document]] by [[PXV:IBitSet|indexes]]. | |
== Syntax == | == Syntax == | ||
| Line 15: | Line 14: | ||
== 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 bitset. |
;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 | ;ppUndoData | ||
| − | :[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 == | ||
Revision as of 05:55, 20 May 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** ppUndoData);
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 bitset.
- 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..
- ppUndoData
- [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.
