IPXC_Pages::InsertPagesFromDoc Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 3: Line 3:
 
{{#customTitle:IPXC_Pages::InsertPagesFromDoc Method}}
 
{{#customTitle:IPXC_Pages::InsertPagesFromDoc Method}}
 
{{#parentPage:PXV:IPXC_Pages|InsertPagesFromDoc Method|method}}
 
{{#parentPage:PXV:IPXC_Pages|InsertPagesFromDoc Method|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Adds pages to the [[PXV:IPXC_Document|current core document]] from the [[PXV:IPXC_Document|source core document]].
  
 
== Syntax ==
 
== Syntax ==
Line 18: Line 17:
 
== Parameters ==
 
== Parameters ==
 
;pSrcDoc
 
;pSrcDoc
:[in]  Pointer to [[PXV:IPXC_Document|IPXC_Document]].
+
:[in]  Pointer to [[PXV:IPXC_Document|IPXC_Document]] containing the source document.
 
;nInsertBefore
 
;nInsertBefore
:[in]  Value of ULONG.
+
:[in]  Select page before which the pages will be inserted. Note that entering value which exceeds or is equal to the pages count in the [[PXV:IPXC_Document|core document]] will insert pages after the last page.
 
;nStartPage
 
;nStartPage
:[in]  Value of ULONG.
+
:[in]  Start page of the page array from the [[PXV:IPXC_Document|source core document]].
 
;nNumPages
 
;nNumPages
:[in]  Value of ULONG.
+
:[in]  Number of pages from [[PXV:IPXC_Document|source core document]] which will be inserted.
 
;nInsertPagesFlags
 
;nInsertPagesFlags
:[in]  Value of ULONG.
+
:[in]  [[PXV:PXC_InsertPagesFlags|Insert page flags]] which set the type of the data that will be copied with pages from the [[PXV:IPXC_Document|source core document]].
 
;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]].
  
 
== Return Value ==
 
== Return Value ==

Revision as of 06:17, 20 May 2015


Adds pages to the current core document from the source core document.

Syntax

HRESULT InsertPagesFromDoc([in]                      IPXC_Document*  pSrcDoc,
                           [in]                      ULONG           nInsertBefore,
                           [in]                      ULONG           nStartPage,
                           [in]                      ULONG           nNumPages,
                           [in]                      ULONG           nInsertPagesFlags,
                           [in, defaultvalue(NULL)]  IProgressMon*   pProgress);

Parameters

pSrcDoc
[in] Pointer to IPXC_Document containing the source document.
nInsertBefore
[in] Select page before which the pages will be inserted. Note that entering value which exceeds or is equal to the pages count in the core document will insert pages after the last page.
nStartPage
[in] Start page of the page array from the source core document.
nNumPages
[in] Number of pages from source core document which will be inserted.
nInsertPagesFlags
[in] Insert page flags which set the type of the data that will be copied with pages from the source core document.
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.

Return Value

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

See Also

IPXC_Pages.