Get number of elements in the default value of a tag.
Declaration:
 Copy Code |
|
|---|---|
AT_ERRCOUNT ACCUAPI IG_ISIS_tag_get_length_default(
HISISDRV hDriver,
AT_MODE nTag,
LPDWORD lpdwLength
);
|
|
Arguments:
| hDriver | The handle to the driver. |
| nTag | Specifies the tag for which to return the length of the default value. |
| lpdwLength | Points to the address which will contain the number of elements in the default value of nTag 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_length_default function retrieves the number of elements in the default value of the specified tag. In the case of an ASCII tag, IG_ISIS_tag_get_length_default returns the number of characters in the current value of the tag. The default value of a tag is specified in the driver.
Use IG_ISIS_tag_get_length_default to retrieve the number of elements or the length of the default value of the tag specified in nTag. This function is especially useful in determining a buffer size to hold the value returned by IG_ISIS_tag_get_ascii_default, because it obtains the number of characters in the default value of the tag, including the NULL terminator. For most other tags, lpdwLength is 1.
Example:
See IG_ISIS_tag_get_length example.
See Also
IG_ISIS_tag_get_rational_default