IIXC_Page::GetPixelIndex Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
Line 9: Line 9:
 
<pre class="brush:cpp;gutter:false">HRESULT GetPixelIndex([in]  LONG  nX,
 
<pre class="brush:cpp;gutter:false">HRESULT GetPixelIndex([in]  LONG  nX,
 
                       [in]  LONG  nY,
 
                       [in]  LONG  nY,
                       [in]  LONG*  Index);</pre>
+
                       [in]  LONG*  nIndex);</pre>
  
 
== Parameters ==
 
== Parameters ==
Line 16: Line 16:
 
;nY
 
;nY
 
:[in]  Specifies y-coordinate of the pixel to be examined.
 
:[in]  Specifies y-coordinate of the pixel to be examined.
;Index
+
;nIndex
 
:[in]  Pointer to LONG variable which will receive the index of the specified pixel's color within the page palette.
 
:[in]  Pointer to LONG variable which will receive the index of the specified pixel's color within the page palette.
  

Latest revision as of 03:16, 15 June 2015

The method retrieves the page palette's color index for the pixel at the specified coordinates..

Syntax

HRESULT GetPixelIndex([in]  LONG   nX,
                      [in]  LONG   nY,
                      [in]  LONG*  nIndex);

Parameters

nX
[in] Specifies x-coordinate of the pixel to be examined.
nY
[in] Specifies y-coordinate of the pixel to be examined.
nIndex
[in] Pointer to LONG variable which will receive the index of the specified pixel's color within the page palette.

Return Value

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

Remarks

For indexed formats (1 bpp, and 8 bpp) the function will return the index of the pixel's color within the page palette; for grayscaled images (Gray, and Gray with Aplha) the function will return the gray level; for TrueColor formats index will contain -1.

See Also

IIXC_Page