You are here:

ID_GetPageInfo function

Function that retrieves information about a specified page of the current image.

Syntax


PLUGIN_API int __stdcall ID_GetPageInfo
(
   ID_StateHdl   hs,
   int           iPage,
   ID_PageInfo*  ppi
);

Parameters

hs

Type: ID_StateHdl

[in] Image state handle; hs is set by the host application to the same value that was passed to it by the plug-in during the relevant call to ID_OpenImage.

iPage

Type: int

[in] Page number (0-based) to get information for.

ppi

Type: ID_PageInfo*

[out] Page information.

Return Value

For a description of return values, see Return Values.

Remarks

The page to retrieve information for is specified by the iPage parameter. This function will only be called after a call ID_OpenImage, and before a call to ID_CloseImage.

Requirements

Header: ID_PlugIn.h