IIXC_Page::Histogramm Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 5: Line 5:
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
The method returns histogram(s) for one or more color channels of the entire page or selected rectangular area.
  
 
== Syntax ==
 
== Syntax ==
Line 16: Line 16:
 
== Parameters ==
 
== Parameters ==
 
;pRed
 
;pRed
:[in, out]  Pointer to ULONG.
+
:[in, out]  Pointer to an array of ULONGs that receives the histogram for the red channel.
 
;pGreen
 
;pGreen
:[in, out]  Pointer to ULONG.
+
:[in, out]  Pointer to an array of ULONGs that receives the histogram for the green channel.
 
;pBlue
 
;pBlue
:[in, out]  Pointer to ULONG.
+
:[in, out]  Pointer to an array of ULONGs that receives the histogram for the blue channel.
 
;pGray
 
;pGray
:[in, out]  Pointer to ULONG.
+
:[in, out]  Pointer to an array of ULONGs that receives the histogram for the gray channel.
 
;pRect
 
;pRect
:[in]  Pointer to RECT.
+
:[in]  Pointer to RECT structure which defines the rectangular area for which color histograms will be calculated. If this parameter is NULL, the entire page will be used.
  
 
== Return Value ==
 
== Return Value ==
 
Returns S_OK if operation was successful or error code in other cases.
 
Returns S_OK if operation was successful or error code in other cases.
 +
 +
== Remarks ==
 +
All UINT arrays passed to the function must have at least 256 items. If one or more histograms isn't needed, the corresponding parameter can be set to NULL.
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IIXC_Page|IIXC_Page]].
+
:[[PXV:IIXC_Page|IIXC_Page]].

Revision as of 05:32, 30 April 2015


The method returns histogram(s) for one or more color channels of the entire page or selected rectangular area.

Syntax

HRESULT Histogramm([in, out]  ULONG*  pRed,
                   [in, out]  ULONG*  pGreen,
                   [in, out]  ULONG*  pBlue,
                   [in, out]  ULONG*  pGray,
                   [in]       RECT*   pRect);

Parameters

pRed
[in, out] Pointer to an array of ULONGs that receives the histogram for the red channel.
pGreen
[in, out] Pointer to an array of ULONGs that receives the histogram for the green channel.
pBlue
[in, out] Pointer to an array of ULONGs that receives the histogram for the blue channel.
pGray
[in, out] Pointer to an array of ULONGs that receives the histogram for the gray channel.
pRect
[in] Pointer to RECT structure which defines the rectangular area for which color histograms will be calculated. If this parameter is NULL, the entire page will be used.

Return Value

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

Remarks

All UINT arrays passed to the function must have at least 256 items. If one or more histograms isn't needed, the corresponding parameter can be set to NULL.

See Also

IIXC_Page.