IIXC_Page::Clone Method

From PDF XChange PDF SDK
Jump to: navigation, search
Line 3: Line 3:
 
{{#parentPage:PXV:IIXC_Page|Clone Method|method}}
 
{{#parentPage:PXV:IIXC_Page|Clone Method|method}}
  
{{ToReview}}
 
  
The method creates an exact copy of a whole page or a specified rectangular area of the page.
+
The '''Clone''' method creates an exact copy of a whole page or a specified rectangular area of the page.
  
 
== Syntax ==
 
== Syntax ==
Line 15: Line 14:
 
:[in, defaultvalue(NULL)]  Pointer to RECT structure which defines the rectangular area of the page page which will be cloned. If this parameter is NULL, the entire page will be cloned.
 
:[in, defaultvalue(NULL)]  Pointer to RECT structure which defines the rectangular area of the page page which will be cloned. If this parameter is NULL, the entire page will be cloned.
 
;ppClone
 
;ppClone
:[out, retval]  Pointer to the variable where [[PXV:IIXC_Page|IIXC_Page]] of cloned page will be stored.
+
:[out, retval]  Pointer to the variable where the [[PXV:IIXC_Page|IIXC_Page]] pointer of the cloned page will be stored.
  
 
== Return Value ==
 
== Return Value ==

Revision as of 11:03, 17 May 2015


The Clone method creates an exact copy of a whole page or a specified rectangular area of the page.

Syntax

HRESULT Clone([in, defaultvalue(NULL)]  RECT*        pRect,
              [out, retval]             IIXC_Page**  ppClone);

Parameters

pRect
[in, defaultvalue(NULL)] Pointer to RECT structure which defines the rectangular area of the page page which will be cloned. If this parameter is NULL, the entire page will be cloned.
ppClone
[out, retval] Pointer to the variable where the IIXC_Page pointer of the cloned page will be stored.

Return Value

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

See Also

IIXC_Page.