IIXC_Page::GetChannelPixel Method

From Tracker Software PDF SDK
Jump to: navigation, search
(See Also)
Line 2: Line 2:
 
{{#customTitle:IIXC_Page::GetChannelPixel Method}}
 
{{#customTitle:IIXC_Page::GetChannelPixel Method}}
 
{{#parentPage:PXV:IIXC_Page|GetChannelPixel Method|method}}
 
{{#parentPage:PXV:IIXC_Page|GetChannelPixel Method|method}}
{{ToWrite}}
+
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
The method of retrieves a value stored into specified color channel at the specified coordinates.
  
 
== Syntax ==
 
== Syntax ==
Line 15: Line 15:
 
== Parameters ==
 
== Parameters ==
 
;nChannel
 
;nChannel
:[in]  Value of [[PXV:IXC_Channel|IXC_Channel]].
+
:[in]  Specifies color [[PXV:IXC_Channel|channel]] from which information will be retrieved.
 
;nX
 
;nX
:[in]  Value of LONG.
+
:[in]  Specifies the x-coordinate of the pixel to be examined.
 
;nY
 
;nY
:[in]  Value of LONG.
+
:[in]  Specifies the y-coordinate of the pixel to be examined.
 
;pValue
 
;pValue
:[out, retval]  Pointer to UCHAR.
+
:[out, retval]  Pointer to UCHAR value that receives the value of color channel at specified pixel.
  
 
== Return Value ==
 
== Return Value ==

Revision as of 04:47, 29 April 2015


The method of retrieves a value stored into specified color channel at the specified coordinates.

Syntax

HRESULT GetChannelPixel([in]           IXC_Channel  nChannel,
                        [in]           LONG         nX,
                        [in]           LONG         nY,
                        [out, retval]  UCHAR*       pValue);

Parameters

nChannel
[in] Specifies color channel from which information will be retrieved.
nX
[in] Specifies the x-coordinate of the pixel to be examined.
nY
[in] Specifies the y-coordinate of the pixel to be examined.
pValue
[out, retval] Pointer to UCHAR value that receives the value of color channel at specified pixel.

Return Value

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

See Also

IIXC_Page
IIXC_Page::CopyChannel
IIXC_Page::FillChannel
IIXC_Page::InvertChannel
IIXC_Page::SetChannelPixel
IXC_Channel