In This Topic ▼

L_TwainGetNumericContainerUNICODEValue

Summary

Gets the specified value from a container.

Syntax

#include "lttwn.h"

L_LTTWN_API L_INT L_TwainGetNumericContainerUNICODEValue(pCapability, nIndex, twUniCode)

Parameters

TW_CAPABILITY * pCapability

Pointer to a TW_CAPABILITY structure that references the container value to get.

L_INT nIndex

Index of the value to get. Possible values are:

Value	Meaning
LTWAIN_VALUE_COUNT	[-1] Update twUniCode with the number of items in the item list of the specified container. This option is only valid if the container is of type TW_ARRAY or TW_ENUMERATION. If the container is of any other type, this function will return an error code.
LTWAIN_VALUE_CURRENT	[-2] Update twUniCode with the current value of the container. If the container is of type TW_RANGE, twUniCode is updated with the CurrentValue member of the TW_RANGE structure. If the container is of type TW_ENUMERATION, twUniCode is updated with the CurrentIndex member of the TW_ENUMERATION structure. If the container is of any other type, the function will return an error code.
LTWAIN_VALUE_DEFAULT	[-3] Update twUniCode with the default value of the container. If the container is of type TW_RANGE, twUniCode is updated with the DefaultValue member of the TW_RANGE structure. If the container is of type TW_ENUMERATION, twUniCode is updated with the DefaultIndex member of the TW_ENUMERATION structure. If the container is of any other type, the function will return an error code.
LTWAIN_VALUE_MINIMUM	[-4] Update twUniCode with the minimum value of the container. If the container is of type TW_RANGE, twUniCode is updated with the MinValue member of the TW_RANGE structure. If the container is of any other type, the function will return an error code.
LTWAIN_VALUE_MAXIMUM	[-5] Update twUniCode with the maximum value of the container. If the container is of type TW_RANGE, twUniCode is updated with the MaxValue member of the TW_RANGE structure. If the container is of any other type, the function will return an error code.
LTWAIN_VALUE_STEPSIZE	[-6] Update twUniCode with the step size of the container. If the container is of type TW_RANGE, twUniCode is updated with the StepSize membr of the TW_RANGE structure. If the container is of any other type, the function will return an error code.
>= 0	Update twUniCode with the value at the specified index. If the container is of type TW_ONEVALUE, nIndex must be zero and twUniCode will be updated with the value of the TW_ONEVALUE structure. If the container is of type TW_ARRAY or TW_ENUMERATION, twUniCode will be updated with the value at the specified index in the list of items. If the container is of type TW_ENUMERATION or TW_ARRAY, the value must not exceed the number of items in the container's item list or the function will return an error code.