IIXC_Page::IsGrayScale Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IIXC_Page::IsGrayScale Method}}
 
{{#customTitle:IIXC_Page::IsGrayScale Method}}
{{#parentPage:PXV:IIXC_Page|method}}
+
{{#parentPage:PXV:IIXC_Page#Methods|IsGrayScale|method}}
{{ToWrite}}
+
{{ToReview}}
+
  
The method of interface of PDF-XChange Editor SDK.
+
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 ==
<pre class="brush:cpp;gutter:false">HRESULT IsGrayScale([out, retval] VARIANT_BOOL* pGray);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT IsGrayScale([out, retval] VARIANT_BOOL* bGray);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pGray''
+
;bGray
:[out, retval]  Pointer to VARIANT_BOOL.
+
:[out, retval]  Specifies the pointer to a VARIANT_BOOL type variable which receives the result.
  
 
== 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 ==
 +
'''IIXC_Page::IsGrayScale''' may be applied to any image of any type.
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IIXC_Page|IIXC_Page]].
+
[[PXV:IIXC_Page|IIXC_Page]]

Latest revision as of 02:16, 15 June 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*  bGray);

Parameters

bGray
[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