IIXC_Page::ConvertToFormat Method
From PDF XChange PDF SDK
(→Parameters) |
|||
| Line 12: | Line 12: | ||
;nFormat | ;nFormat | ||
:[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. |
| − | : | + | :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 == | ||
Revision as of 11:11, 17 May 2015
ConvertToFormat converts an existing page to one of the supported internal formats.
Contents
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.
