Hand Held Products 4X00 manual OemGetImage, Resultt oemGetImage

Page 21

oemGetImage

This function retrieves an image from the engine and stores it in memory pointed to by pImageBuffer.

Result_t oemGetImage (

BYTE *pImageBuffer, DWORD *pdwSize, WORD nTop, WORD nLeft, WORD nRight, WORD nBottom, WORD nSkip, WORD nBits, FileFormat_t nFormat, WORD nWhiteValue, WORD nExposeAttempts, WORD nGap,

BOOL Invert

void ( *fpProgress ) (WORD)

)

Return Values

RESULT_SUCCESS

RESULT_ERR_UNSUPPORTED

RESULT_ERR_DRIVER

RESULT_ERR_PARAMETER

RESULT_ERR_NORESPONSE

RESULT_ERR_BADREGION

RESULT_ERR_MEMORY

RESULT_ERR_FILE

Parameters

pImageBuffer

Memory pointer to where the image should be stored. The caller must allocate this buffer before calling oemGetImage.

pdwSize

Upon successful return, the number of bytes of image data stored in pImageBuffer.

nTop, nLeft

Coordinates relative to the image engine's pixel grid for first pixel of the transferred image. The upper left pixel has both an nLeft and an nTop value of 0.

nRight, nBottom

Coordinates relative to the image engine's pixel grid for last pixel of the transferred image.

nSkip:

When transferring an image, transfer every nSkip pixel.

nBits

The color depth for the transferred image. Valid values are typically only 8 or 1, but this depends on the engine hardware. Independent of the bits used, a lower value is darker than a higher value. For example, if 8 bits are chosen, then a pixel value of 255 indicates pure white, and a pixel value of 0 indicates pure black. Values in between are to be interpreted as incremental levels of gray.

nFormat: FF_RAW_BINARY

The black and white data stored in the pImageBuffer is stored 1 bit per pixel starting with the upper left pixel and proceeding sequentially left to right and top to bottom.

FF_RAW_GRAY

The grayscale data stored in the pImageBuffer is stored 8 bit per pixel starting with the upper left pixel and proceeding sequentially left to right and top to bottom.

nWhiteValue

The target white value when performing auto exposure control.

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide

2 - 7

Image 21
Contents User’s Guide Disclaimer Table of Contents Page Symbology Identifiers Page Introduction Features of the 4X00 Series Image Engine API Library Summary Page Page Data Type Definitions Tchar Page OemAimerOn OemAcquireImageOemDefaultSymbology OemDisableSymbologyOemConnect OemEnableSymbology OemDisableSymbologyAllOemEnableSymbologyAll OemDisconnectOemGetAPIRevision OemGetDecodeAttemptLimitOemGetDecodeCenteringWindow OemGetDecodeMode OemGetDecoderRevisionOemGetDecodeTime OemGetExposureSettings OemGetErrorMessageResultt oemGetErrorMessage Resultt oemGetExposureSettingsResultt oemGetImage OemGetImageOemGetImagerInfo OemGetImageDataPrototype Resultt oemGetImageData Resultt oemGetImagerInfoPnCols OemGetImagerPropertiesResultt oemGetImagerProperties PImgPropOemGetLastImageExt OemGetLastImageResultt oemGetLastImage Resultt oemGetLastImageExtOemGetLeaveLightsOn OemGetLastImageSizeResultt oemGetLastImageSize Resultt oemGetLeaveLightsOnOemGetPrintWeight OemGetLinearRangeOemGetMaxMessageChars OemGetSetupAll OemGetScanDriverRevisionOemGetSearchTimeLimit OemGetSetupAusPost OemGetSetupAztecOemGetSetupBPO OemGetSetupChinaPost OemGetSetupCanPostResultt oemGetSetupCanPost Resultt oemGetSetupChinaPostOemGetSetupCodablock OemGetSetupCodabarResultt oemGetSetupCodabar Resultt oemGetSetupCodablockResultt oemGetSetupCode11 OemGetSetupCode11OemGetSetupCode16K OemGetSetupCode128Resultt oemGetSetupCode128 Resultt oemGetSetupCode16KOemGetSetupCode39 OemGetSetupCode32Resultt oemGetSetupCode32 Resultt oemGetSetupCode39Resultt oemGetSetupCode49 OemGetSetupCode49PbFullAscii PbAppendOemGetSetupComposite OemGetSetupCode93Resultt oemGetSetupCode93 Resultt oemGetSetupCompositeOemGetSetupCompositeEx Resultt oemGetSetupCompositeExPbCompositeOnUpcEan OemGetSetupDataMatrix OemGetSetupCouponCodeResultt oemGetSetupCouponCode Resultt oemGetSetupDataMatrixOemGetSetupEAN8 OemGetSetupDutchPostResultt oemGetSetupDutchPost Resultt oemGetSetupEAN8OemGetSetupEAN13 Resultt oemGetSetupIATA25 OemGetSetupIATA25OemGetSetupInt25 OemGetSetupImagerPrototype Resultt oemGetSetupImager Resultt oemGetSetupInt25OemGetSetupISBT OemGetSetupJapostOemGetSetupKoreanPost OemGetSetupMaxicode Resultt oemGetSetupMaxicodePCarrierMsgOnly OemGetSetupMesa Resultt oemGetSetupMesaP9MSEnabled OemGetSetupMSI Resultt oemGetSetupMSIPMinLength PMaxLength OemGetSetupOCR OemGetSetupMx25Resultt oemGetSetupMx25 Resultt oemGetSetupOCRPszGroupG PszGroupHPszCheckChar OemGetSetupPlessey OemGetSetupPlanetResultt oemGetSetupPlanet Resultt oemGetSetupPlesseyOemGetSetupPosiCode Resultt oemGetSetupPosiCodePLimited OemGetSetupQR OemGetSetupPostnetResultt oemGetSetupPostnet Resultt oemGetSetupQROemGetSetupStrt25 OemGetSetupRSSResultt oemGetSetupRSS Resultt oemGetSetupStrt25OemGetSetupTLC39 OemGetSetupTelepenResultt oemGetSetupTelepen Resultt oemGetSetupTLC39OemGetSetupUPCA OemGetSetupTriopticResultt oemGetSetupTrioptic Resultt oemGetSetupUPCAResultt oemGetSetupUPCE OemGetSetupUPCEPE1Enabled PE0EnabledOemGetVideoReverse PbExpandVersionEOemImageStreamInit OemImageStreamStartOemImageStreamRead OemImageStreamStop OemPowerOffImagerOemLeaveLightsOn OemLightsOnOemSetDecodeAttemptLimit Resultt oemPowerOffImagerOemSetDecodeCenteringWindow Resultt oemSetDecodeAttemptLimitOemSetExposureSettings OemSetDecodeModeOemSetExposureMode OemSetLinearRange OemSetPrintWeightOemSetScanningLightsMode Resultt oemSetLinearRangeOemSetupAztec OemSetupChinaPostOemSetSearchTimeLimit OemSetupCodablock OemSetupCodabarResultt oemSetupCodabar Resultt oemSetupCodablockOemSetupCode128 OemSetupCode11Resultt oemSetupCode11 Resultt oemSetupCode128OemSetupCode39 OemSetupCode16KResultt oemSetupCode16K Resultt oemSetupCode39Resultt oemSetupCode49 OemSetupCode49BFullAscii BAppendOemSetupCode93 OemSetupCompositeOemSetupCompositeEx OemSetupEAN8 OemSetupDataMatrixResultt oemSetupDataMatrix Resultt oemSetupEAN8OemSetupEAN13 Resultt oemSetupEAN13BAddendaReq OemSetupInt25 OemSetupIATA25Resultt oemSetupIATA25 Resultt oemSetupInt25OemSetupMaxicode OemSetupKoreanPostResultt oemSetupKoreanPost Resultt oemSetupMaxicodeResultt oemSetupMesa OemSetupMesaOemSetupMx25 OemSetupMSIResultt oemSetupMSI Resultt oemSetupMx25Resultt oemSetupOCR OemSetupOCRNFont PszTemplateOemSetupPlessey OemSetupPlanetResultt oemSetupPlanet Resultt oemSetupPlesseyOemSetupPosiCode OemSetupPostnetOemSetupQR OemSetupStrt25 OemSetupRSSResultt oemSetupRSS Resultt oemSetupStrt25OemSetupUPCA OemSetupTelepenResultt oemSetupTelepen Resultt oemSetupUPCAOemSetupUPCE Resultt oemSetupUPCEBXmitNumSys OemSetVideoReverse BEnabledOemStartIntellImgXfer BExpandVersionEResultt oemStartIntellImgXfer Resultt oemWaitForDecode OemWaitForDecodeResultt oemWaitForDecodeRaw OemWaitForDecodeRawResultt oemWaitMultipleDecode OemWaitMultipleDecodeFpMultiReadCallBack OemWaitMultipleDecodeRawFpContinueCallBack Resultt oemWaitMultipleDecodeRawSymbology Identifiers Function Result Values Mail latechsupport@handheld.com Mail eutechsupport@handheld.comMail aptechsupport@handheld.com Imageteam 4X00 Series Software Development Kit SDK Page Hand Held Products, Inc