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_default
In This Topic
    IG_ISIS_tag_set_default
    In This Topic

    Set a tag to its default value.

    Declaration:

     
    Copy Code
    AT_ERRCOUNT ACCUAPI IG_ISIS_tag_set_default(
            HISISDRV hDriver,
            AT_MODE nTag
    );
    

    Arguments:

    Name Type Description
    hDriver HISISDRV The handle to the driver.
    nTag AT_MODE Specifies the tag to reset.

    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_default function resets the specified tag to its default value. It does not set a new default value.

    Use IG_ISIS_tag_set_default to set the specified nTag to the default value that was assigned to it in the driver. The default value is set by the driver developer by the first IG_ISIS_tag_set... call for each tag that is created in the driver. The application has no way to reset or change these defaults.

    Example:

    The following line of code resets all tags to their default values:

     
    Copy Code
          IG_ISIS_tag_set_default(hDriver, 0);
    

    See Also

    IG_ISIS_tag_get_ascii_default

    IG_ISIS_tag_get_length_default

    IG_ISIS_tag_get_long_default

    IG_ISIS_tag_get_rational_default

    IG_ISIS_tag_set_ascii

    IG_ISIS_tag_set_long

    IG_ISIS_tag_set_rational