IIXC_Page::ConvertToFormat Method
From PDF XChange PDF SDK
(Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| (11 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IIXC_Page::ConvertToFormat Method}} | {{#customTitle:IIXC_Page::ConvertToFormat Method}} | ||
| + | {{#parentPage:PXV:IIXC_Page#Methods|ConvertToFormat|method}} | ||
| − | + | '''ConvertToFormat''' converts an existing page to one of the supported internal formats. | |
== 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 nFormat);</pre> |
== Parameters == | == Parameters == | ||
| − | ; | + | ;nFormat |
| − | :[in] | + | :[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. | ||
| + | :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 == | == Return Value == | ||
| Line 15: | Line 19: | ||
== See Also == | == See Also == | ||
| − | + | [[PXV:IIXC_Page|IIXC_Page]] | |
Latest revision as of 03:16, 15 June 2015
ConvertToFormat converts an existing page to one of the supported internal formats.
Syntax
HRESULT ConvertToFormat([in] IXC_PageFormat nFormat);
Parameters
- nFormat
- [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.
