ImageGear for C and C++ on Windows v19.6 - Updated
IG_ISIS_tag_get_ascii_default
API Reference Guide > ISIS Component API Reference > ISIS Component Functions Reference > Tag Functions > IG_ISIS_tag_get_ascii_default

Get the default value of an ASCII tag.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_ISIS_tag_get_ascii_default(
        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 default 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_default function retrieves the ASCII string 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_ascii_default to retrieve the ASCII string that is the default value of the ASCII tag specified in nTag. The IG_ISIS_tag_get_length default function can be used to determine the actual length of the string.

Use of IG_ISIS_tag_get_ascii_default 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_default to determine the default value of IG_ISIS_TAG_ENDORSER_STRING:

 
Copy Code
case GETDEFAULT:
        rc = IG_ISIS_tag_get_ascii_default(hDriver, IG_ISIS_TAG_ENDORSER_STRING,
                                                         ENDORSER_MAXLEN, lpszBuf);
        if (rc)                                 /* If error return error code           */
                return -1L;
        if (*lpszBuf == '\0')    /* If no string then no endorser                                       */
                return (LONG) FALSE;
        return (LONG) TRUE;

See Also

IG_ISIS_tag_get_ascii

IG_ISIS_tag_get_length

IG_ISIS_tag_get_type

IG_ISIS_tag_set_ascii