IIXC_Page::Crop Method

From Tracker Software PDF SDK
Jump to: navigation, search
(See Also)
(Parameters)
Line 11: Line 11:
 
== Parameters ==
 
== Parameters ==
 
;pRect
 
;pRect
:[in]  Pointer to RECT structure which defines the rectangular cropping area.
+
:[in]  Pointer to RECT structure which defines the rectangular cropping area. If this parameter is <tt>NULL</tt> the function will do nothing. If it specifies an empty rectangle, or an rectangle that has no intersection with [[PXV:IIXC_Page_Rect|page's rectangle]], function will fail.
  
 
== Return Value ==
 
== Return Value ==

Revision as of 15:53, 18 May 2015


The Crop method crops the specified page to the specified rectangular area.

Syntax

HRESULT Crop([in]  RECT*  pRect);

Parameters

pRect
[in] Pointer to RECT structure which defines the rectangular cropping area. If this parameter is NULL the function will do nothing. If it specifies an empty rectangle, or an rectangle that has no intersection with page's rectangle, function will fail.

Return Value

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

See Also

IIXC_Page
IIXC_Page::Clone