Oemgetsetupcode11, Oemgetsetupcode11 -17 – Hand Held Products 4X00 User Manual

Page 31

Advertising
background image

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

2 - 17

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.

pMinLength

Points to a WORD variable that contains the minimum length decoded Codablock message the engine should return.
Codablock messages smaller than this minimum length are not reported by the engine. The default value is 0.

pMaxLength

Points to a WORD variable that contains the maximum length decoded Codablock message the engine should return.
Codablock messages larger than this maximum length are reported by the engine. The default value is 2048.

pbXmitCheckChar

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

oemGetSetupCode11

This function is used to get the Code 11 symbology-specific options.

Result_t

oemGetSetupCode11 (
SetupType_t SetupType,
BOOL *pEnabled,
WORD *pMinLength,
WORD *pMaxLength,
BOOL *pbXmitCheckChar
)

Return Values

RESULT_SUCCESS
RESULT_ERR_PARAMETER

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.

pMinLength

Points to a WORD variable that contains the minimum length decoded Code 11 message the engine should return.
Code 11 messages smaller than this minimum length are not reported by the engine. The default value is 4.

pMaxLength

Points to a WORD variable that contains the maximum length decoded Code 11 message the engine should return.
Code 11 messages larger than this maximum length are reported by the engine. The default value is 80.

pbXmitCheckChar

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

Advertising