ImageGear for C and C++ on Windows v19.0
IG_ISIS_tag_get_ascii

Get the current value of an ASCII tag.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_ISIS_tag_get_ascii(
        HISISDRV hDriver,
        AT_MODE nTag,
        WORD wLength,
        LPSTR lpszValue
);

Arguments:

Name Type Description
hDriver HISISDRV The handle to the driver.
nTag AT_MODE Specifies the ASCII tag for which to return the current value.
wLength WORD Specifies the number of characters of the ASCII value to copy into lpcBuffer.
lpszValue LPSTR Points to a buffer to hold at most wLength bytes of nTag.

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_ascii function retrieves the ASCII string that is the current value of the specified tag.

Use IG_ISIS_tag_get_ascii to retrieve the ASCII string that is the current value of the ASCII tag specified in nTag. The IG_ISIS_tag_get_length function can be used to determine the actual length of the string.

Use of IG_ISIS_tag_get_ascii on a non-ASCII tag 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.

Example:

The following code fragment uses IG_ISIS_tag_get_ascii to help determine which dither mode has been selected:

 
Copy Code
/* figure out which dither mode has been selected (result in n) */IG_ISIS_tag_get_ascii(hDriver, IG_ISIS_TAG_DITHER, 128, lpcBuffer2);IG_ISIS_choice_get_count(hDriver, IG_ISIS_TAG_DITHER, &wCount);
for (n=0; n<(int)wCount; n++) {IG_ISIS_choice_get_ascii(hDriver, IG_ISIS_TAG_DITHER, n, lpcBuffer1);
        if (!strcmp(lpcBuffer1, lpcBuffer2))
        break;
}

See Also

IG_ISIS_tag_get_ascii_default

IG_ISIS_tag_get_length

IG_ISIS_tag_get_type

IG_ISIS_tag_set_ascii

 

 


©2017. Accusoft Corporation. All Rights Reserved.

Send Feedback