IIXC_Image::GetPage Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 5: Line 5:
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
The method retrieves the [[PXV:IIXC_Page|IIXC_Page]] of the specified page without removing it from the image.
  
 
== Syntax ==
 
== Syntax ==
Line 14: Line 14:
 
== Parameters ==
 
== Parameters ==
 
;nIndex
 
;nIndex
:[in]  Value of ULONG.
+
:[in]  Specifies zero-based index of the requested page.
 
;pProgress
 
;pProgress
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IProgressMon|IProgressMon]].
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IProgressMon|IProgressMon]].
 
;ppPage
 
;ppPage
:[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]] of the requested page.
  
 
== Return Value ==
 
== Return Value ==

Revision as of 05:05, 7 May 2015


The method retrieves the IIXC_Page 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**    ppPage);

Parameters

nIndex
[in] Specifies zero-based index of the requested page.
pProgress
[in, defaultvalue(NULL)] Pointer to IProgressMon.
ppPage
[out, retval] Specifies a pointer to the variable which receives the IIXC_Page of the requested page.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

See also IIXC_Image.