IIXC_Page::ConvertToFormat 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 ConvertToFormat([in]  IXC_PageFormat  nFormat);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT ConvertToFormat([in]  IXC_PageFormat  Format);</pre>
  
 
== Parameters ==
 
== Parameters ==
;nFormat
+
;Format
 
:[in]  Specifies the [[PXV:IXC_PageFormat|format]] to which the page will be converted.  
 
:[in]  Specifies the [[PXV:IXC_PageFormat|format]] to which the page will be converted.  
 
:An existing alpha-channel will be removed when converting to these formats: PageFormat_1Indexed, PageFormat_8Indexed, PageFormat_8Gray, PageFormat_8RGB, PageFormat_16Gray, PageFormat_16RGB.
 
:An existing alpha-channel will be removed when converting to these formats: PageFormat_1Indexed, PageFormat_8Indexed, PageFormat_8Gray, PageFormat_8RGB, PageFormat_16Gray, PageFormat_16RGB.

Revision as of 06:50, 12 June 2015

ConvertToFormat converts an existing page to one of the supported internal formats.

Syntax

HRESULT ConvertToFormat([in]  IXC_PageFormat  Format);

Parameters

Format
[in] Specifies the format to which the page will be converted.
An existing alpha-channel will be removed when converting to these formats: PageFormat_1Indexed, PageFormat_8Indexed, PageFormat_8Gray, PageFormat_8RGB, PageFormat_16Gray, PageFormat_16RGB.
A non-existent alpha-channel will be created when converting to these formats: PageFormat_8AlphaGray,PageFormat_8ARGB, PageFormat_16AlphaGray, PageFormat_16ARGB, PageFormat_Vector

Return Value

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

See Also

IIXC_Page