IIXC_Page::CopyChannel Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(14 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IIXC_Page::CopyChannel Method}}
 
{{#customTitle:IIXC_Page::CopyChannel Method}}
{{#parentPage:PXV:IIXC_Page|method}}
+
{{#parentPage:PXV:IIXC_Page#Methods|CopyChannel|method}}
{{ToWrite}}
+
{{ToReview}}
+
  
The method of interface of PDF-XChange Editor SDK.
+
The '''CopyChannel''' method copies specified color channel information from one page to another.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT CopyChannel([in] IXC_Channel dstChannel, [in] IIXC_Page* srcFrom, [in] IXC_Channel srcChannel, [in] RECT* pRect, [in] LONG nSX, [in] LONG nSY);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT CopyChannel([in] IXC_Channel nDstChannel,
 +
                    [in] IIXC_Page*   pSrcFrom,
 +
                    [in] IXC_Channel nSrcChannel,
 +
                    [in] RECT*       stRect,
 +
                    [in] LONG         nSX,
 +
                    [in] LONG         nSY);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''dstChannel''
+
;nDstChannel
:[in]  Value of [[PXV:IXC_Channel|IXC_Channel]].
+
:[in]  Specifies the [[PXV:IXC_Channel|Color Channel]] of the page into which data will be copied.
;''srcFrom''
+
;pSrcFrom
:[in]  Pointer to [[PXV:IIXC_Page|IIXC_Page]].
+
:[in]  Specifies the source [[PXV:IIXC_Page|IIXC_Page]] from which data will be copied.
;''srcChannel''
+
;nSrcChannel
:[in]  Value of [[PXV:IXC_Channel|IXC_Channel]].
+
:[in]  Specifies the [[PXV:IXC_Channel|color channel]] of the '''pSrcFrom''' from which data will copied.
;''pRect''
+
;stRect
:[in]  Pointer to RECT.
+
:[in]  Pointer to RECT which defines the rectangular area on the page where date should be copied. If this parameter is <tt>NULL</tt>, entire page will be used.
;''nSX''
+
;nSX
:[in]  Value of LONG.
+
:[in]  Specifies the x-coordinate, in pixels, on the upper-left corner of the source rectangle.
;''nSY''
+
;nSY
:[in]  Value of LONG.
+
:[in]  Specifies the y-coordinate, in pixels, of the upper-left corner of the source rectangle.
  
 
== Return Value ==
 
== Return Value ==
Line 28: Line 32:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IIXC_Page|IIXC_Page]].
+
[[PXV:IIXC_Page|IIXC_Page]]

Latest revision as of 02:16, 15 June 2015

The CopyChannel method copies specified color channel information from one page to another.

Syntax

HRESULT CopyChannel([in]  IXC_Channel  nDstChannel,
                    [in]  IIXC_Page*   pSrcFrom,
                    [in]  IXC_Channel  nSrcChannel,
                    [in]  RECT*        stRect,
                    [in]  LONG         nSX,
                    [in]  LONG         nSY);

Parameters

nDstChannel
[in] Specifies the Color Channel of the page into which data will be copied.
pSrcFrom
[in] Specifies the source IIXC_Page from which data will be copied.
nSrcChannel
[in] Specifies the color channel of the pSrcFrom from which data will copied.
stRect
[in] Pointer to RECT which defines the rectangular area on the page where date should be copied. If this parameter is NULL, entire page will be used.
nSX
[in] Specifies the x-coordinate, in pixels, on the upper-left corner of the source rectangle.
nSY
[in] Specifies the y-coordinate, in pixels, of the upper-left corner of the source rectangle.

Return Value

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

See Also

IIXC_Page