ImageGear for C and C++ on Windows v21.0 - Updated
API Reference Guide / ISIS Component API Reference / ISIS Component Functions Reference / Tag Functions / IG_ISIS_tag_set_ascii
In This Topic
    IG_ISIS_tag_set_ascii
    In This Topic

    Set the value of an ASCII tag.

    Declaration:

     
    Copy Code
    AT_ERRCOUNT ACCUAPI IG_ISIS_tag_set_ascii(
            HISISDRV hDriver,
            AT_MODE nTag,
            LPSTR lpszValue
    );
    

    Arguments:

    Name Type Description
    hDriver HISISDRV The handle to the driver.
    nTag AT_MODE Specifies the ASCII tag to set.
    lpszValue LPSTR Points to a buffer that contains the string to which to set 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_set_ascii function sets the value of the specified ASCII tag to the specified string.

    Use IG_ISIS_tag_set_ascii to set the specified nTag to the ASCII string in lpcBuffer. IG_ISIS_tag_set_ascii automatically sets the tag's length.

    Example:

    The following example gets the ASCII value of the choice for IG_ISIS_TAG_DITHER whose index value is 2 (the third choice), and then sets this tag to that value:

     
    Copy Code
          IG_ISIS_choice_get_ascii(hDriver, IG_ISIS_TAG_DITHER, 2, caBuffer);IG_ISIS_tag_set_ascii(hDriver, IG_ISIS_TAG_DITHER, caBuffer);
    

    See Also

    IG_ISIS_tag_get_ascii

    IG_ISIS_tag_set_default

    IG_ISIS_tag_set_long

    IG_ISIS_tag_set_rational