IIXC_Image::GetPage Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(17 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IIXC_Image::GetPage Method}}
 
{{#customTitle:IIXC_Image::GetPage Method}}
 +
{{#parentPage:PXV:IIXC_Image#Methods|GetPage|method}}
  
−
The method of interface of PDF-XChange Editor SDK.
+
The method retrieves the [[PXV:IIXC_Page|IIXC_Page]] pointer of the specified page without removing it from the image.
  
 
== Syntax ==
 
== Syntax ==
−
<pre class="brush:cpp;gutter:false">HRESULT GetPage([in] ULONG nIndex, [in, optional, defaultvalue(NULL)] IProgressMon* pProgress, [out, retval] IIXC_Page** ppPage);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT GetPage([in]                     ULONG         nIndex,
 +
                [in, defaultvalue(NULL)] IProgressMon* pProgress,
 +
                [out, retval]             IIXC_Page**   pPage);</pre>
  
 
== Parameters ==
 
== Parameters ==
−
;''nIndex''
+
;nIndex
−
:[in]  Value of ULONG.
+
:[in]  Specifies zero-based index of the requested page.
−
;''pProgress''
+
;pProgress
−
:[in, optional, defaultvalue(NULL)]  Pointer to [[PXV:IProgressMon|IProgressMon]].
+
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IProgressMon|IProgressMon]].
−
;''ppPage''
+
;pPage
−
:[out, retval]  Pointer to [[PXV:IIXC_Page|IIXC_Page]].
+
:[out, retval]  Specifies a pointer to the variable which receives the [[PXV:IIXC_Page|IIXC_Page]] pointer of the requested page.
  
 
== Return Value ==
 
== Return Value ==
−
Returns S_OK if operation was successful or error code in other cases.
+
Returns S_OK if the operation was successful, and will return an error code if it fails.
  
 
== See Also ==
 
== See Also ==
−
See also [[PXV:IIXC_Image|IIXC_Image]].
+
[[PXV:IIXC_Image|IIXC_Image]]

Latest revision as of 02:15, 15 June 2015

Images Core Layer > Interfaces > IIXC_Image > IIXC_Image::GetPage Method

The method retrieves the IIXC_Page pointer of the specified page without removing it from the image.

Syntax

HRESULT GetPage([in]                      ULONG          nIndex,
                [in, defaultvalue(NULL)]  IProgressMon*  pProgress,
                [out, retval]             IIXC_Page**    pPage);

Parameters

nIndex
[in] Specifies zero-based index of the requested page.
pProgress
[in, defaultvalue(NULL)] Pointer to IProgressMon.
pPage
[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.

See Also

IIXC_Image

Retrieved from "https://sdkhelp.pdf-xchange.com/index.php?title=PXV:IIXC_Image_GetPage&oldid=44510"