IIXC_Image::GetPage Method
From PDF XChange PDF SDK
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 GetPage([in] ULONG | + | <pre class="brush:cpp;gutter:false">HRESULT GetPage([in] ULONG Index, |
| − | [in, defaultvalue(NULL)] IProgressMon* | + | [in, defaultvalue(NULL)] IProgressMon* Progress, |
| − | [out, retval] IIXC_Page** | + | [out, retval] IIXC_Page** Page);</pre> |
== Parameters == | == Parameters == | ||
| − | ; | + | ;Index |
:[in] Specifies zero-based index of the requested page. | :[in] Specifies zero-based index of the requested page. | ||
| − | ; | + | ;Progress |
:[in, defaultvalue(NULL)] Pointer to [[PXV:IProgressMon|IProgressMon]]. | :[in, defaultvalue(NULL)] Pointer to [[PXV:IProgressMon|IProgressMon]]. | ||
| − | ; | + | ;Page |
:[out, retval] Specifies a pointer to the variable which receives the [[PXV:IIXC_Page|IIXC_Page]] pointer of the requested page. | :[out, retval] Specifies a pointer to the variable which receives the [[PXV:IIXC_Page|IIXC_Page]] pointer of the requested page. | ||
Revision as of 05:49, 12 June 2015
The method retrieves the IIXC_Page pointer of the specified page without removing it from the image.
Syntax
HRESULT GetPage([in] ULONG Index,
[in, defaultvalue(NULL)] IProgressMon* Progress,
[out, retval] IIXC_Page** Page);
Parameters
- Index
- [in] Specifies zero-based index of the requested page.
- Progress
- [in, defaultvalue(NULL)] Pointer to IProgressMon.
- Page
- [out, retval] Specifies a pointer to the variable which receives the IIXC_Page pointer of the requested page.
Return Value
Returns S_OK if the operation was successful, and will return an error code if it fails.
