IIXC_Page::IsGrayScale Method

From PDF XChange PDF SDK
Jump to: navigation, search
Line 5: Line 5:
 
{{ToReview}}
 
{{ToReview}}
  
The method determines if the image page is grayscale. A page is considered grayscale if RGB components are the same within each color value.
+
The '''IsGrayScale''' method determines if the image page is grayscale. A page is considered grayscale if RGB components are the same within each color value.
  
 
== Syntax ==
 
== Syntax ==
Line 12: Line 12:
 
== Parameters ==
 
== Parameters ==
 
;pGray
 
;pGray
:[out, retval]  Specifies the pointer to the value of VARIANT_BOOL type which receives the result.
+
:[out, retval]  Specifies the pointer to a VARIANT_BOOL type variable which receives the result.
  
 
== Return Value ==
 
== Return Value ==

Revision as of 11:27, 18 May 2015


The IsGrayScale method determines if the image page is grayscale. A page is considered grayscale if RGB components are the same within each color value.

Syntax

HRESULT IsGrayScale([out, retval]  VARIANT_BOOL*  pGray);

Parameters

pGray
[out, retval] Specifies the pointer to a VARIANT_BOOL type variable which receives the result.

Return Value

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

Remarks

IIXC_Page::IsGrayScale may be applied to any image of any type.

See Also

IIXC_Page
IIXC_Page::ToGrayScale