IIXC_Page::GetChannelPixel Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(15 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IIXC_Page::GetChannelPixel Method}}
 
{{#customTitle:IIXC_Page::GetChannelPixel Method}}
{{#parentPage:PXV:IIXC_Page|method}}
+
{{#parentPage:PXV:IIXC_Page#Methods|GetChannelPixel|method}}
{{ToWrite}}
+
{{ToReview}}
+
  
The method of interface of PDF-XChange Editor SDK.
+
The '''GetChannelPixel''' method retrieves the pixel color channel value stored at the specified coordinates.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT GetChannelPixel([in] IXC_Channel nChannel, [in] LONG nX, [in] LONG nY, [out, retval] UCHAR* pValue);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT GetChannelPixel([in]           IXC_Channel nChannel,
 +
                        [in]           LONG         nX,
 +
                        [in]           LONG         nY,
 +
                        [out, retval] UCHAR*       nValue);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''nChannel''
+
;nChannel
:[in]  Value of [[PXV:IXC_Channel|IXC_Channel]].
+
:[in]  Specifies the [[PXV:IXC_Channel|color 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''
+
;nValue
:[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 ==
Line 24: Line 26:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IIXC_Page|IIXC_Page]].
+
[[PXV:IIXC_Page|IIXC_Page]]

Latest revision as of 03:16, 15 June 2015

The GetChannelPixel method retrieves the pixel color channel value stored at the specified coordinates.

Syntax

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

Parameters

nChannel
[in] Specifies the 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.
nValue
[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