Hand Held Products 5080, Руководство пользователя, Страница: 11 / 64

5X80 Series Software Development Kit (SDK) User’s Guide 1 - 5
Data Types, Structures, and Enumerated Types
The 5X80 SDK API uses structures (see Structures and Mask Definitions beginning on page 4-1) and enumerated types (see
Enumerated Types and Definitions beginning on page 3-1) extensively . The definitions are in the include files in the 5X80 SDK
package. All 5X80 SDK-specific structures have a dwStructSize member that must be set to sizeof( struct name ). This insures
that the structure being passed to a given function is the structure type expected by the function and, if writing is done to the
structure, that the structure size boundary is not exceeded. Furthermore, all imager configuration structures (except the all
inclusive structure HHP_CONFIG) have a DWORD member dwMask. The mask allows you to specify only certain members
within a structure. Set the mask value by ORing together the appropriate masks for the given structure for the particular items
within the structure that should be read/written. Samples of programs that demonstrate this can be found in Program Samples
beginning on page 6-1. This technique is also used by Microsoft
®
in their Windows
®
SDK (for example, see Windows
®
SDK
structure CHARFORMAT).
The following Windows
®
data types are included for clarity.
Note: A “P” in front of a data type means a pointer to the type.
hhpGetLastImage
Initiates transfer of the last image captured. (This includes images captured
during barcode scan.) The call can be made synchronously or
asynchronously, and the transfer parameters can be specified.
2-5
Intelligent Imaging (Signature Capture) Functions
Intelligent imaging is barcode capture combined with an image window capture. The image window is cut from the same image
used to capture a barcode. This is how the SDK provides the ability to capture a signature associated with a barcode. In fact, a
successful barcode capture is required before the intelligent image window is sent by the imager. You can specify whether the
image is returned grayscale or black and white.
hhpAcquireIntelligentImage Barcode capture combined with an image window capture. 2-1
hhpRawAcquireIntelligentImage Captures portion of the image in which a barcode is decoded. 2-6
Miscellaneous Functions
hhpSendActionCommand
Turns on illumination LEDs, Aimers, (and sound beeper for imagers that have
one) outside the image or barcode capture.
2-9
hhpSendMessage Sends menu commands to the imager. 2-9
hhpUpgradeFirmware Upgrades the current imager firmware with a new firmware file. 2-11
hhpSetHardwareLineDllFileName
Allows you to specify the name of an OEM dll file. This file can contain some
or all of the OemDll exports that provide support for hardware trigger and low
power mode hardware lines.
2-11
Windows Data Types
BOOL 32 bit signed integer used by most Microsoft SDK functions in place of a true Boolean.
BYTE 8 bit unsigned variable.
DWORD 32 bit unsigned integer variable.
HANDLE
A Windows WIN32 handle type. Returned from opening files, creating events, semaphores, or
mutexes.
HWND A Windows handle to an application window.
PVOID 32 bit unsigned integer that points to void data type (generic pointer).
TCHAR OS-dependent character variable. 16 bit for Unicode systems, otherwise 8 bits.
WORD 16 bit unsigned integer variable.
HHP_EVENT_CALLBACK
Pointer to a callback function (see hhpImgrSdk.h) called in response to the completion of an
asynchronous 5X80 SDK function call or event. (See example on
page 6-4 .)
Core Functions (Continued)
Core Function Summary
Page