Oemgetsetupupce, Oemgetsetupupce -40 – Hand Held Products 4X00 User Manual

Page 54

Advertising
background image

2 - 40

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

Parameters

SetupType

SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings.

pEnabled

Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function. A TRUE
means the symbology is enabled; a FALSE means the symbology is disabled.

pbXmitCheckDigit

Points to a BOOL variable that determines if the engine will return the check digit as part of the data string after a
successful decode. If TRUE, the engine returns the check digit. If FALSE, the check digit is not returned. The default
value is FALSE.

pbAddendaReq

Points to a BOOL variable that determines if the engine will decode only UPC bar codes that have a 2 or 5 digit addenda.
If TRUE, the engine decodes only UPC symbols with an addenda. If FALSE, the engine decodes all enabled UPC
symbols. The default value is FALSE.

pbAddendaSeparator

Points to a BOOL variable that determines if there is a space character between the data from the bar code and the
data from the addenda. If TRUE, there is a space. If FALSE, there is no space. The default value is FALSE.

pbAddenda2Digit

Points to a BOOL variable that determines if the engine will look for a 2 digit addenda at the end of the UPC bar code.
If TRUE, and an addenda is present, the engine adds the two digit addenda data to the end of the message. If FALSE,
the engine ignores addenda data. The default value is FALSE.

pbAddenda5Digit

Points to a BOOL variable that determines if the engine will look for a 5 digit addenda at the end of the UPC bar code.
If TRUE, and an addenda is present, the engine adds the five digit addenda data to the end of the message. If FALSE,
the engine ignores addenda data. The default value is FALSE.

pbXmitNumSys

Points to a BOOL variable that determines if the engine will return the numeric system digit of the UPC label. If TRUE,
the engine returns the number system digit. If FALSE, the number system digit is not returned. The default value is
TRUE.

oemGetSetupUPCE

This function is used to get the UPC-E symbology-specific options.

Result_t

oemGetSetupUPCE (
SetupType_t SetupType,
BOOL *pE0Enabled,
BOOL *pE1Enabled,
BOOL *pbXmitCheckDigit,
BOOL *pbAddendaReq,
BOOL *pbExpandVersionE,
BOOL *pbAddendaSeparator,
BOOL *pbAddenda2Digit,
BOOL *pbAddenda5Digit,
BOOL *pbXmitNumSys
)

Return Values

RESULT_SUCCESS
RESULT_ERR_PARAMETER

Advertising