PageGetFrameInfo Method

public IPROFRAME GetFrameInfo(
	int Index,
	[OptionalAttribute] IMAGEINDEX Image
)

Public Function GetFrameInfo ( 
	Index As Integer,
	<OptionalAttribute> Image As IMAGEINDEX
) As IPROFRAME

public:
IPROFRAME GetFrameInfo(
	[InAttribute] int Index, 
	[OptionalAttribute] [InAttribute] IMAGEINDEX Image
)

Parameters

Index

Type: SystemInt32

Image (Optional)

Type: Kofax.OmniPageCSDK.IproPlusIMAGEINDEX

Return Value

The returned information is provided in an IPROFRAME structure. The Index parameter contains the zero based index of the desired frame. It must be in the 0 to (FrameInfoCount - 1) range, otherwise a trappable error occurs. The optional image parameter (type IMAGEINDEX) determines the mapping of the returned coordinates. Its default value is II_CURRENT.

Possible values for IMAGEINDEX are listed under the IMAGEINDEX Enumeration topic. Since frames are detected during recognition, no frame information is available before a page is recognized.

The IPROFRAME structure is documented in the IPRO Structures chapter.

Reference