Hand Held Products 5080, User Manual

Page: 19 / 64

5X80 Series Software Development Kit (SDK) User’s Guide 2 - 5
hhpGetErrorMessage
This function returns a text message describing the meaning of a Result_t error code. See Error Codes on page 3-1 for complete
descriptions.
Syntax hhpGetErrorMessage
(
Result_t nErrorCode,
P TCHAR ptcErrorMsg,
int nMaxChars
)
Parameter Description
nErrorCode Error code returned from one of the other 5X80 SDK functions.
ptcErrMsg TCHAR buffer to hold error message string.
nMaxChars Maximum number of characters that can fit in ptcErrorMsg including NULL.
hhpGetLastImage
This function causes the imager to transfer the last image captured to the host. If bWait is TRUE, the function will not return until
the image is fully received or an error occurs. If bWait is FALSE, the function returns immediately and you are notified when
image transfer has completed or an error has occurred. pImgTrans is an optional parameter and can be NULL. Setting the
appropriate bit mask for each item specifies active members of this structure. This function can be used to obtain the image from
the last barcode capture attempt as well as the last image from an image capture attempt.
Syntax hhpGetLastImage
(
P HHP_IMAGE pImg,
P HHP_IMAGE_TRANSFER pImgTrans,
BOOL bWait
)
Parameter Description
pImg Pointer to an HHP_IMAGE structure if bWait is TRUE. If bWait is FALSE, the parameter is ignored
and should be NULL.
pImgTrans Optional pointer to an HHP_IMAGE_TRANSFER structure. This structure overrides (just for this call)
the current imager configuration, and specifies the pixel subsample, cropping rectangle, transfer
compression type, compression factor (for JPEG lossy transfer), and progress notification method.
If this parameter is NULL, the current imager configuration settings are used except for the progress
notification methods that must be specified for each call if notification is desired.
bWait If TRUE, do not return until the image is received or an error occurs. If FALSE, return immediately.
One of the event notification methods must be enabled to receive notification on completion.
hhpNamedConnect
This function opens a connection to an imager. The connection must be closed by calling hhpDisconnect (page 2-4). The caller
can verify that the imager is connected by calling hhpEngineConnected (page 2-4).
Syntax hhpNamedConnect
(
P TCHAR ptcConnectName,
PVOID pStruct
)
Parameter Description
ptcConnectName The name of driver for the hardware port, e.g., "COM1:" or "\\.\COM12."
pStruct
An optional structure that contains setup information for the hardware port, or NULL.
HHP_SERIAL_PORT_CONFIG is used to configure a serial port connection.