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)
Line 7: Line 7:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT GetChannelPixel([in]          IXC_Channel  nChannel,
+
<pre class="brush:cpp;gutter:false">HRESULT GetChannelPixel([in]          IXC_Channel  Channel,
 
                         [in]          LONG        nX,
 
                         [in]          LONG        nX,
 
                         [in]          LONG        nY,
 
                         [in]          LONG        nY,
                         [out, retval]  UCHAR*      nValue);</pre>
+
                         [out, retval]  UCHAR*      Value);</pre>
  
 
== Parameters ==
 
== Parameters ==
;nChannel
+
;Channel
 
:[in]  Specifies the [[PXV:IXC_Channel|color channel]] from which information will be retrieved.
 
:[in]  Specifies the [[PXV:IXC_Channel|color channel]] from which information will be retrieved.
 
;nX
 
;nX
Line 19: Line 19:
 
;nY
 
;nY
 
:[in]  Specifies the y-coordinate of the pixel to be examined.
 
:[in]  Specifies the y-coordinate of the pixel to be examined.
;nValue
+
;Value
 
:[out, retval]  Pointer to UCHAR value that receives the value of color channel at specified pixel.
 
:[out, retval]  Pointer to UCHAR value that receives the value of color channel at specified pixel.
  

Revision as of 06:50, 12 June 2015

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

Syntax

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

Parameters

Channel
[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.
Value
[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