LTwain::GetNumericContainerFRAMEValue

#include "ltwrappr.h"

virtual L_INT LTwain::GetNumericContainerFRAMEValue(pCapability, nIndex, ptwFrame)

TW_CAPABILITY * pCapability;	/* pointer to a structure */
L_INT nIndex;	/* value's index */
TW_FRAME *ptwFrame;	/* pointer to a TW_FRAME value */

Gets the specified value from a container.

Parameter	Description
pCapability	Pointer to a TW_CAPABILITY structure that references the container value to get.
nIndex	Index of the value to get. Possible values are:
	Value	Meaning
	LTWAIN_VALUE_COUNT	[-1] Update ppValue 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 ppValue with the current value of the container. If the container is of type TW_RANGE, ppValue is updated with the CurrentValue member of the TW_RANGE structure. If the container is of type TW_ENUMERATION, ppValue 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 ppValue with the default value of the container. If the container is of type TW_RANGE, ppValue is updated with the DefaultValue member of the TW_RANGE structure. If the container is of type TW_ENUMERATION, ppValue 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 ppValue with the minimum value of the container. If the container is of type TW_RANGE, ppValue 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 ppValue with the maximum value of the container. If the container is of type TW_RANGE, ppValue 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 ppValue with the step size of the container. If the container is of type TW_RANGE, ppValue 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 ppValue with the value at the specified index. If the container is of type TW_ONEVALUE, nIndex must be zero and ppValue will be updated with the value of the TW_ONEVALUE structure. If the container is of type TW_ARRAY or TW_ENUMERATION, ppValue 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.
ptwFrame	Reference to a TW_FRAME value to be updated with the specified container value.

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

Use this function to get a value from a container's item list when the item list type is TW_FRAME.

Required DLLs and Libraries

LTTWN

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions:	LTwain::GetNumericContainerItemType, LTwain::GetNumericContainerINTValue, LTwain::GetNumericContainerUINTValue, LTwain::GetNumericContainerBOOLValue, LTwain::GetNumericContainerFIX32Value, LTwain::GetNumericContainerSTRINGValue, LTwain::GetNumericContainerUNICODEValue.
Topics:	How to Work with the Containers
	TWAIN Functionality: Container Functions.

Example

// initialize session and call this function
L_INT LTwain__GetNumericContainerFRAMEValueExample(LTwain *MyClass)
{
   L_INT          nRet;
   L_INT          nItemType;
   TW_FRAME       ptwFrame;
   TW_CAPABILITY  twCap; 
   // Fill the TW_CAPABILITY structure with values
   twCap.Cap = ICAP_FRAMES;
   twCap.ConType = TWON_ONEVALUE; 
   nRet = MyClass->GetCapability(&twCap, LTWAIN_CAPABILITY_GETCURRENT); 
   if (nRet != SUCCESS)
   {
      MessageBox (NULL, TEXT("Failed to get capability"), TEXT("ERROR"), MB_OK);
      return nRet;
   }
   nRet = MyClass->GetNumericContainerItemType(&twCap, &nItemType); 
   if (nRet != SUCCESS) 
   {
      MessageBox (NULL, TEXT("Failed to get capability item type"), TEXT("ERROR"), MB_OK); 
      return nRet;
   }
   else if (nItemType == TWTY_BOOL)
   {
      nRet = MyClass->GetNumericContainerFRAMEValue (&twCap, 0, &ptwFrame); 
      if (nRet != SUCCESS) 
      {
         MessageBox (NULL, TEXT("Failed to get capability item value"), TEXT("ERROR"), MB_OK); 
         return nRet;
      }
   }
   return SUCCESS;
}