Hand Held Products 4X00 - Manual (Page 9)

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 1 - 3
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
condition
2-6
oemGetImagerProperties Returns information about the imager 2-9
oemGetLeaveLightsOn
Return parameter reflecting operation mode of illumination
LEDs during scanning
2-11
oemGetScanDriverRevision
Returns the revision of the scan driver component that
interfaces to the OEM API layer
2-13
oemLeaveLightsOn
Configure illumination LEDs to be always on or in normal mode
during scanning
2-43
oemPowerOffImager
Allows the application to fully power down the imager for
additional power control
2-43
Decoder Functions
oemDefaultSymbology
Return some or all symbology options back to factory default
settings
2-2
oemDisableSymbology Disable decoding of specific bar code symbologies 2-2
oemDisableSymbologyAll
Disable decoding of all symbologies, including unknown
symbologies
2-3
oemEnableSymbology Enable decoding of specific bar code symbologies 2-3
oemEnableSymbologyAll
Enable decoding of all symbologies, including unknown
symbologies
2-3
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
mode
2-12
oemGetMaxMessageChars
Retrieve the size of the largest possible message (in
characters)
2-12
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
decoding options
2-14
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