IIXC_Page::CopyChannel Method

From Tracker Software PDF SDK
Jump to: navigation, search
Line 2: Line 2:
 
{{#customTitle:IIXC_Page::CopyChannel Method}}
 
{{#customTitle:IIXC_Page::CopyChannel Method}}
 
{{#parentPage:PXV:IIXC_Page|CopyChannel Method|method}}
 
{{#parentPage:PXV:IIXC_Page|CopyChannel Method|method}}
 
+
{{ToReview}}
  
 
The '''CopyChannel''' method copies specified color channel information from one page to another.
 
The '''CopyChannel''' method copies specified color channel information from one page to another.
Line 16: Line 16:
 
== Parameters ==
 
== Parameters ==
 
;dstChannel
 
;dstChannel
:[in]  Specifies the [[PXV:IXC_Channel|Color Channel]] of the destPage into which data will be copied.
+
:[in]  Specifies the [[PXV:IXC_Channel|Color Channel]] of the page into which data will be copied.
 
;srcFrom
 
;srcFrom
:[in]  Pointer to the [[PXV:IIXC_Page|IIXC_Page]] of the source page.
+
:[in]  Specifies the [[PXV:IIXC_Page|source page]] from which data will be copied.
 
;srcChannel
 
;srcChannel
:[in]  Specifies the [[PXV:IXC_Channel|Color Channel]] of the pageFrom from which data will copied.
+
:[in]  Specifies the [[PXV:IXC_Channel|color channel]] of the '''srcFrom''' from which data will copied.
 
;pRect
 
;pRect
:[in]  Pointer to RECT structure which defines the rectangular area of the source page from which data will be copied. If this parameter is <tt>NULL</tt>, entire page will be used.
+
:[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]  Specifies the x-coordinate, in pixels, of the upper-left corner of the destination rectangle.
+
:[in]  Specifies the x-coordinate, in pixels, on the upper-left corner of the source rectangle.
 
;nSY
 
;nSY
:[in]  Specifies the y-coordinate, in pixels, of the upper-left corner of the destination rectangle.
+
:[in]  Specifies the y-coordinate, in pixels, of the upper-left corner of the source rectangle.
  
 
== Return Value ==
 
== Return Value ==

Revision as of 15:50, 18 May 2015


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

Syntax

HRESULT CopyChannel([in]  IXC_Channel  dstChannel,
                    [in]  IIXC_Page*   srcFrom,
                    [in]  IXC_Channel  srcChannel,
                    [in]  RECT*        pRect,
                    [in]  LONG         nSX,
                    [in]  LONG         nSY);

Parameters

dstChannel
[in] Specifies the Color Channel of the page into which data will be copied.
srcFrom
[in] Specifies the source page from which data will be copied.
srcChannel
[in] Specifies the color channel of the srcFrom from which data will copied.
pRect
[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
IIXC_Page::FillChannel
IIXC_Page::GetChannelPixel
IIXC_Page::InvertChannel
IIXC_Page::SetChannelPixel
IIXC_Page::Place
IXC_Channel