IPXC_Pages::InsertPagesFromDoc Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
Line 18: Line 18:
 
:[in]  Pointer to [[PXV:IPXC_Document|IPXC_Document]] containing the source document.
 
:[in]  Pointer to [[PXV:IPXC_Document|IPXC_Document]] containing the source document.
 
;nInsertBefore
 
;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 [[PXV:IPXC_Document|core document]] will insert pages after the last page. Entering a value of zero (0) will place the empty pages before the first page in the document.
+
:[in]  Select page before which the pages will be inserted. Note that entering value that exceeds or is equal to the pages count in the [[PXV:IPXC_Document|core document]] will insert pages after the last page. Entering a value of zero (0) will place the empty pages before the first page in the document.
 
;nStartPage
 
;nStartPage
 
:[in]  Zero-based start page of the page array from the [[PXV:IPXC_Document|source core document]].
 
:[in]  Zero-based start page of the page array from the [[PXV:IPXC_Document|source core document]].
 
;nNumPages
 
;nNumPages
:[in]  Number of pages from [[PXV:IPXC_Document|source core document]] which will be inserted.
+
:[in]  Number of pages from [[PXV:IPXC_Document|source core document]] that will be inserted.
 
;nInsertPagesFlags
 
;nInsertPagesFlags
:[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]].
+
:[in]  [[PXV:PXC_InsertPagesFlags|Insert page flags]] that 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]] 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]].

Latest revision as of 01:20, 25 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 that exceeds or is equal to the pages count in the core document will insert pages after the last page. Entering a value of zero (0) will place the empty pages before the first page in the document.
nStartPage
[in] Zero-based start page of the page array from the source core document.
nNumPages
[in] Number of pages from source core document that will be inserted.
nInsertPagesFlags
[in] Insert page flags that 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