com.zebra.scannercontrol

Enum DCSSDKDefs.DCSSDK_RESULT

java.lang.Object

java.lang.Enum<DCSSDKDefs.DCSSDK_RESULT>

com.zebra.scannercontrol.DCSSDKDefs.DCSSDK_RESULT

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DCSSDKDefs.DCSSDK_RESULT>

Enclosing class:

DCSSDKDefs

public static enum DCSSDKDefs.DCSSDK_RESULT
extends java.lang.Enum<DCSSDKDefs.DCSSDK_RESULT>

These constants are defined to represent result codes that can be returned by SDK API functions.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DCSSDK_RESULT_FAILURE A particular API function has completed unsuccessfully.
DCSSDK_RESULT_FIRMWARE_UPDATE_ABORTED Firmware Upgrade aborted for specified scanner.
DCSSDK_RESULT_FIRMWARE_UPDATE_FAILED_COMMANDS_ARE_OUT_OF_SYNC Firmware update is failed due to commands are out of sync.
DCSSDK_RESULT_FIRMWARE_UPDATE_FAILED_HAS_OVERLAPPING_ADDRESS Firmware update is failed due to firmware has overlapping address
DCSSDK_RESULT_FIRMWARE_UPDATE_FAILED_LOAD_COUNT_ERROR Firmware update is failed due to a load count error
DCSSDK_RESULT_FIRMWARE_UPDATE_FAILED_LOW_BATTERY_LEVEL Firmware update is not allowed when the battery percentage is below 20%.
DCSSDK_RESULT_FIRMWARE_UPDATE_IN_PROGRESS A Firmware Upgrade is in progress for specified scanner.
DCSSDK_RESULT_INVALID_PARAMS A particular API function has completed unsuccessfully due to invalid input and/or output parameters.
DCSSDK_RESULT_OPCODE_NOT_SUPPORTED A particular API function has completed unsuccessfully due to unsupported opcode.
DCSSDK_RESULT_RESPONSE_TIMEOUT A particular API function has completed unsuccessfully due to expiration of a response timeout during communication with a particular scanner.
DCSSDK_RESULT_SCALE_NOT_PRESENT Scale is not available in the specified scanner.
DCSSDK_RESULT_SCANNER_ALREADY_ACTIVE Scanner that trying to establish the connection is already active
DCSSDK_RESULT_SCANNER_NOT_ACTIVE A particular API function has completed unsuccessfully because a specified scanner was not active.
DCSSDK_RESULT_SCANNER_NOT_AVAILABLE A particular API function has completed unsuccessfully because a specified scanner was not available.
DCSSDK_RESULT_SUCCESS A particular API function has completed successfully.

Field Summary

Fields

Modifier and Type	Field and Description
int	value

Method Summary

Modifier and Type	Method and Description
static DCSSDKDefs.DCSSDK_RESULT	getDCSDKResultByValue(int value) Retrieves the DCSSDK_RESULT enum for the given value(result code)
int	getValue()
static DCSSDKDefs.DCSSDK_RESULT	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DCSSDKDefs.DCSSDK_RESULT[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DCSSDK_RESULT_SUCCESS

public static final DCSSDKDefs.DCSSDK_RESULT DCSSDK_RESULT_SUCCESS

A particular API function has completed successfully.

DCSSDK_RESULT_FAILURE

public static final DCSSDKDefs.DCSSDK_RESULT DCSSDK_RESULT_FAILURE

A particular API function has completed unsuccessfully.

DCSSDK_RESULT_SCANNER_NOT_AVAILABLE

public static final DCSSDKDefs.DCSSDK_RESULT DCSSDK_RESULT_SCANNER_NOT_AVAILABLE

A particular API function has completed unsuccessfully because a specified scanner was not available.

DCSSDK_RESULT_SCANNER_NOT_ACTIVE

public static final DCSSDKDefs.DCSSDK_RESULT DCSSDK_RESULT_SCANNER_NOT_ACTIVE

A particular API function has completed unsuccessfully because a specified scanner was not active.

DCSSDK_RESULT_INVALID_PARAMS

public static final DCSSDKDefs.DCSSDK_RESULT DCSSDK_RESULT_INVALID_PARAMS

A particular API function has completed unsuccessfully due to invalid input and/or output parameters.

DCSSDK_RESULT_RESPONSE_TIMEOUT

public static final DCSSDKDefs.DCSSDK_RESULT DCSSDK_RESULT_RESPONSE_TIMEOUT

A particular API function has completed unsuccessfully due to expiration of a response timeout during communication with a particular scanner.

DCSSDK_RESULT_OPCODE_NOT_SUPPORTED

public static final DCSSDKDefs.DCSSDK_RESULT DCSSDK_RESULT_OPCODE_NOT_SUPPORTED

A particular API function has completed unsuccessfully due to unsupported opcode.

DCSSDK_RESULT_SCANNER_ALREADY_ACTIVE

public static final DCSSDKDefs.DCSSDK_RESULT DCSSDK_RESULT_SCANNER_ALREADY_ACTIVE

Scanner that trying to establish the connection is already active

DCSSDK_RESULT_FIRMWARE_UPDATE_IN_PROGRESS

public static final DCSSDKDefs.DCSSDK_RESULT DCSSDK_RESULT_FIRMWARE_UPDATE_IN_PROGRESS

A Firmware Upgrade is in progress for specified scanner.

DCSSDK_RESULT_FIRMWARE_UPDATE_ABORTED

public static final DCSSDKDefs.DCSSDK_RESULT DCSSDK_RESULT_FIRMWARE_UPDATE_ABORTED

Firmware Upgrade aborted for specified scanner.

DCSSDK_RESULT_SCALE_NOT_PRESENT

public static final DCSSDKDefs.DCSSDK_RESULT DCSSDK_RESULT_SCALE_NOT_PRESENT

Scale is not available in the specified scanner.

DCSSDK_RESULT_FIRMWARE_UPDATE_FAILED_LOW_BATTERY_LEVEL

public static final DCSSDKDefs.DCSSDK_RESULT DCSSDK_RESULT_FIRMWARE_UPDATE_FAILED_LOW_BATTERY_LEVEL

Firmware update is not allowed when the battery percentage is below 20%.

DCSSDK_RESULT_FIRMWARE_UPDATE_FAILED_COMMANDS_ARE_OUT_OF_SYNC

public static final DCSSDKDefs.DCSSDK_RESULT DCSSDK_RESULT_FIRMWARE_UPDATE_FAILED_COMMANDS_ARE_OUT_OF_SYNC

Firmware update is failed due to commands are out of sync.

DCSSDK_RESULT_FIRMWARE_UPDATE_FAILED_HAS_OVERLAPPING_ADDRESS

public static final DCSSDKDefs.DCSSDK_RESULT DCSSDK_RESULT_FIRMWARE_UPDATE_FAILED_HAS_OVERLAPPING_ADDRESS

Firmware update is failed due to firmware has overlapping address

DCSSDK_RESULT_FIRMWARE_UPDATE_FAILED_LOAD_COUNT_ERROR

public static final DCSSDKDefs.DCSSDK_RESULT DCSSDK_RESULT_FIRMWARE_UPDATE_FAILED_LOAD_COUNT_ERROR

Firmware update is failed due to a load count error

Field Detail

value

public int value

Method Detail

values

public static DCSSDKDefs.DCSSDK_RESULT[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DCSSDKDefs.DCSSDK_RESULT c : DCSSDKDefs.DCSSDK_RESULT.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DCSSDKDefs.DCSSDK_RESULT valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getValue

public int getValue()

getDCSDKResultByValue

public static DCSSDKDefs.DCSSDK_RESULT getDCSDKResultByValue(int value)

Retrieves the DCSSDK_RESULT enum for the given value(result code)

Parameters:

value - result code

Returns:

Corresponding DCSSDK_RESULT enum