IIXC_Image::GetPage Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(8 intermediate revisions by 3 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|GetPage Method|method}}
+
{{#parentPage:PXV:IIXC_Image#Methods|GetPage|method}}
 
+
  
 
The method retrieves the [[PXV:IIXC_Page|IIXC_Page]] pointer of the specified page without removing it from the image.
 
The method retrieves the [[PXV:IIXC_Page|IIXC_Page]] pointer of the specified page without removing it from the image.
Line 9: Line 9:
 
<pre class="brush:cpp;gutter:false">HRESULT GetPage([in]                      ULONG          nIndex,
 
<pre class="brush:cpp;gutter:false">HRESULT GetPage([in]                      ULONG          nIndex,
 
                 [in, defaultvalue(NULL)]  IProgressMon*  pProgress,
 
                 [in, defaultvalue(NULL)]  IProgressMon*  pProgress,
                 [out, retval]            IIXC_Page**    ppPage);</pre>
+
                 [out, retval]            IIXC_Page**    pPage);</pre>
  
 
== Parameters ==
 
== Parameters ==
Line 16: Line 16:
 
;pProgress
 
;pProgress
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IProgressMon|IProgressMon]].
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IProgressMon|IProgressMon]].
;ppPage
+
;pPage
 
:[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.
  
 
== 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 ==
 
[[PXV:IIXC_Image|IIXC_Image]]
 
[[PXV:IIXC_Image|IIXC_Image]]

Latest revision as of 02:15, 15 June 2015

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