LIsis::GetTagLongChoice

#include "ltwrappr.h"

virtual L_INT LIsis::GetTagLongChoice(uTag, nIndex, plValue)

L_UINT uTag;	/* ASCII tag */
L_INT32 nIndex;	/* index value */
L_INT32 *plValue;	/* pointer to a variable */

Gets the number of possible values (or choices), or gets the value at the specified index, for the specified ISIS Scanner Driver Long Tag. This function is available in the Document/Medical Toolkits.

Parameter	Description
uTag	Value indicating the tag for which to get the specified value, or the number of possible values. For a list of possible tags, refer to ISIS Long tags.
nIndex	Index into an array of possible values (or choices) for the specified long tag. This value must be between 0 and the maximum number of values/choices - 1. Pass ISIS_DEFAULT to update plValue with the maximum number of available values/choices for the specified tag.
plValue	Pointer to a variable to be updated with the value at the specified index. If nIndex is ISIS_DEFAULT, this parameter will be updated with the maximum number of available values/choices for the specified tag.

Returns

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

Comments

ISIS tags can have multiple values, also called choices. This function can be used to get the maximum number of available values/choices, or to get individual values.

To get the maximum number of available values/choices, pass ISIS_DEFAULT for nIndex. The plValue parameter will be updated with the number of available values/choices.

Required DLLs and Libraries

LTISI

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:	LIsis::GetTagLong, LIsis::SetTagLong, LIsis::GetTagShort, LIsis::SetTagShort, LIsis::GetTagShortChoice, LIsis::GetTagASCII, LIsis::GetTagASCIIChoice, LIsis::SetTagASCII
Topics:	Raster Image Functions: Scanning Images using ISIS
	Using ISIS to Scan Images

Example

L_VOID IsisLongTagsChoicesExample(LIsis & Isis)
{
   L_INT32 lChoiceValue;
   L_INT32 lChoicesCount;
   L_CHAR szMessage[256];

   // Get the number of choices available for TAG_IMAGEWIDTH
   Isis.GetTagLongChoice(TAG_IMAGEWIDTH, ISIS_DEFAULT, &lChoicesCount);

   wsprintfA(szMessage, "There are %d choices for TAG_IMAGEWIDTH",
lChoicesCount);

   MessageBoxA(NULL, szMessage, "Long Tags Choices Example", MB_OK);

   /* Get and display each choice for TAG_IMAGEWIDTH */
   for (L_INT32 x = 0; x < lChoicesCount; x++)
   {
      Isis.GetTagLongChoice(TAG_IMAGEWIDTH, x, &lChoiceValue);
      wsprintfA(szMessage, "Choice %d is: %d", x, lChoiceValue);
      MessageBoxA(NULL, szMessage, "Long Tags Choices Example", MB_OK);
   }
}