IIXC_Page::CopyChannel Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
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}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
The method copies specified color channel information from one page to another.
  
 
== Syntax ==
 
== Syntax ==
Line 17: Line 16:
 
== Parameters ==
 
== Parameters ==
 
;dstChannel
 
;dstChannel
:[in]  Value of [[PXV:IXC_Channel|IXC_Channel]].
+
:[in]  Specifies [[PXV:IXC_Channel|channel]] of the destPage into which data will be copied.
 
;srcFrom
 
;srcFrom
:[in]  Pointer to [[PXV:IIXC_Page|IIXC_Page]].
+
:[in]  Pointer to [[PXV:IIXC_Page|IIXC_Page]] of the source page.
 
;srcChannel
 
;srcChannel
:[in]  Value of [[PXV:IXC_Channel|IXC_Channel]].
+
:[in]  Specifies the [[PXV:IXC_Channel|channel]] of the pageFrom from which data will copied.
 
;pRect
 
;pRect
:[in]  Pointer to RECT.
+
:[in]  Pointer to RECT structure which defines the rectangular area of the page into which data will be copied. If this parameter is NULL, entire page will be used.
 
;nSX
 
;nSX
:[in]  Value of LONG.
+
:[in]  Specifies the x-coordinate, in pixels, of the upper-left corner of the destination rectangle.
 
;nSY
 
;nSY
:[in]  Value of LONG.
+
:[in]  Specifies the y-coordinate, in pixels, of the upper-left corner of the destination rectangle.
  
 
== Return Value ==
 
== Return Value ==
Line 33: Line 32:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IIXC_Page|IIXC_Page]].
+
:[[PXV:IIXC_Page|IIXC_Page]]
 +
:[[PXV:IIXC_Page_FillChannel|IIXC_Page::FillChannel]]
 +
:[[PXV:IIXC_Page_GetChannelPixel|IIXC_Page::GetChannelPixel]]
 +
:[[PXV:IIXC_Page_InvertChannel|IIXC_Page::InvertChannel]]
 +
:[[PXV:IIXC_Page_SetChannelPixel|IIXC_Page::SetChannelPixel]]
 +
:[[PXV:IXC_Channel|IXC_Channel]]

Revision as of 02:55, 29 April 2015


The 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 channel of the destPage into which data will be copied.
srcFrom
[in] Pointer to IIXC_Page of the source page.
srcChannel
[in] Specifies the channel of the pageFrom from which data will copied.
pRect
[in] Pointer to RECT structure which defines the rectangular area of the page into which data will be copied. If this parameter is NULL, entire page will be used.
nSX
[in] Specifies the x-coordinate, in pixels, of the upper-left corner of the destination rectangle.
nSY
[in] Specifies the y-coordinate, in pixels, of the upper-left corner of the destination 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
IXC_Channel