IPXC_Page::GetMatrix Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_Page::GetMatrix Method}}
 
{{#customTitle:IPXC_Page::GetMatrix Method}}
 +
{{#parentPage:PXV:IPXC_Page#Methods|GetMatrix|method}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Gets [[PXV:PXC_Matrix|page transformation matrix]] for custom [[PXV:PXC_BoxType|page box]].
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT GetMatrix([in] PXC_BoxType nRelativeBox, [out, retval] PXC_Matrix* pMatrix);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT GetMatrix([in]           PXC_BoxType nRelativeBox,
 +
                  [out, retval] PXC_Matrix* stMatrix);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''nRelativeBox''
+
;nRelativeBox
:[in]  Value of [[PXV:PXC_BoxType|PXC_BoxType]].
+
:[in]  Choose the [[PXV:PXC_BoxType|box]] for which the resulting matrix will be filled.
;''pMatrix''
+
;stMatrix
:[out, retval]  Pointer to [[PXV:PXC_Matrix|PXC_Matrix]].
+
:[out, retval]  Pointer to [[PXV:PXC_Matrix|PXC_Matrix]] containing the resuling matrix.
  
 
== Return Value ==
 
== Return Value ==
Line 17: Line 21:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXC_Page|IPXC_Page]].
+
[[PXV:IPXC_Page|IPXC_Page]]

Latest revision as of 03:32, 15 June 2015


Gets page transformation matrix for custom page box.

Syntax

HRESULT GetMatrix([in]           PXC_BoxType  nRelativeBox,
                  [out, retval]  PXC_Matrix*  stMatrix);

Parameters

nRelativeBox
[in] Choose the box for which the resulting matrix will be filled.
stMatrix
[out, retval] Pointer to PXC_Matrix containing the resuling matrix.

Return Value

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

See Also

IPXC_Page