Get the default value of a tag of type long.
Declaration:
 Copy Code |
|
|---|---|
AT_ERRCOUNT ACCUAPI IG_ISIS_tag_get_long_default(
HISISDRV hDriver,
AT_MODE nTag,
WORD wIndex,
LPLONG lplValue
);
|
|
Arguments:
| hDriver | The handle to the driver. |
| nTag | Specifies the type long tag for which to return the default value. |
| wIndex | Specifies the index of the element to get. Most tags have only one element, in which case wIndex must be zero. Use IG_ISIS_tag_get_length_default to determine how many elements a tag contains. |
| lplValue | Points to the default value of the tag after this function completes. |
Return Value:
Returns the number of ImageGear errors that occurred during this function call. If there are no errors, the return value is IGE_SUCCESS.
Supported Raster Image Formats:
This function does not process image pixels.
Remarks:
The IG_ISIS_tag_get_long_default function retrieves the long value that is the default value of the specified tag. The default value of a tag is specified in the driver.
Use IG_ISIS_tag_get_long_default to retrieve the default value of the type long tag specified in nTag. Use IG_ISIS_tag_get_length_default to get the number of elements in the tag. If the tag has only one element, wIndex must be zero. If the tag has multiple elements (such as IG_ISIS_TAG_GAMMA_TABLE1), loop on IG_ISIS_tag_get_long_default to obtain all elements of the default value of the tag.
Use of IG_ISIS_tag_get_long_default on a tag other than one of type long, short, or byte is undefined. At best, this will cause an invalid return value or a operating system error message, and at worst will cause the system to crash. Passing anything other than a pointer to a long to lplValue, even if the tag is of type byte or short, is also undefined. On some systems, a proper value may be returned, but memory corruption will occur on others.
See Also
IG_ISIS_tag_get_length_default