Hand Held Products 4X00 manual Image Engine API Library Summary

Image Engine API Library Summary

The following is a summary of the API functions. The full description of each of function is found on the page noted.

Core Function	Summary Description	Page
oemAimerOn	Turn on/off the engine's aiming LEDs	2-1
oemConnect	Initialize connection with engine device	2-2
oemDisconnect	Close the connection to the engine device	2-3
oemGetAPIRevision	Retrieve the API library's software revision information	2-4
oemGetDecodeMode	Retrieve the decoding mode of the engine	2-5
oemGetErrorMessage	Given an error number, returns a string describing the error	2-6
	condition
oemGetImagerProperties	Returns information about the imager	2-9
oemGetLeaveLightsOn	Return parameter reflecting operation mode of illumination	2-11
	LEDs during scanning
oemGetScanDriverRevision	Returns the revision of the scan driver component that	2-13
	interfaces to the OEM API layer
oemLeaveLightsOn	Configure illumination LEDs to be always on or in normal mode	2-43
	during scanning
oemPowerOffImager	Allows the application to fully power down the imager for	2-43
	additional power control
Decoder Functions
oemDefaultSymbology	Return some or all symbology options back to factory default	2-2
	settings
oemDisableSymbology	Disable decoding of specific bar code symbologies	2-2
oemDisableSymbologyAll	Disable decoding of all symbologies, including unknown	2-3
	symbologies
oemEnableSymbology	Enable decoding of specific bar code symbologies	2-3
oemEnableSymbologyAll	Enable decoding of all symbologies, including unknown	2-3
	symbologies
oemGetDecodeAttemptLimit	Retrieves the current decode attempt maximum time limit	2-4
oemGetDecodeCenteringWindow	Enable decode centering mode	2-4
oemGetDecodeTime	Returns time to decode in milliseconds	2-5
oemGetDecoderRevision	Retrieve decoder’s current revision	2-5
oemGetLinearRange	Get the size of the window used in Advanced Linear decoding	2-12
	mode
oemGetMaxMessageChars	Retrieve the size of the largest possible message (in	2-12
	characters)
oemGetPrintWeight	Retrieve the current or default print weight the decoder expects	2-12
oemGetSearchTimeLimit	Retrieves the current search maximum time limit	2-13
oemGetSetupAll	Gets all symbology decoding options	2-13
oemGetSetupAusPost	Gets the Australian Postal Code symbology decoding options	2-14
oemGetSetupAztec	Gets the Aztec and Aztec Mesa Code symbology-specific	2-14
	decoding options
oemGetSetupBPO	Gets the British Postal Code symbology decoding options	2-14
oemGetSetupCanPost	Gets the Canadian Postal Code symbology decoding options	2-15
oemGetSetupChinaPost	Gets the Chinese Postal Code symbology decoding options	2-15

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