IIXC_Image::GetPage Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 20: Line 20:
  
 
== 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]]

Revision as of 14:20, 20 May 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**    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 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