Nicomsoft OCR: Developer's Guide


Img_GetProperty


Syntax

C++:int Img_GetProperty(HIMG ImgObj, int PropertyID)
C#:int Img_GetProperty(int ImgObj, int PropertyID)
Visual Basic:Function Img_GetProperty(ByVal ImgObj As Integer, ByVal PropertyID As Integer) As Integer
Java:int Img_GetProperty(HIMG ImgObj, int PropertyID)
Delphi:function Img_GetProperty(ImgObj:HIMG; PropertyID:integer):integer


Description

Retrieves such properties of the original image as DPI, color depth, and size.


Parameters

ImgObj [IN] – the Image object.
PropertyID [IN] – the property to retrieve. See the IMG_PROP_XXXXX constants for possible values.


Return value

If success, the property value; if the property is not defined, zero; otherwise, an error code.


Remarks

None.


Example

See the sample code for the Img_GetPixLineCnt function.