Restore tag value(s) saved by IG_ISIS_tag_save_value.

Declaration:

AT_ERRCOUNT ACCUAPI IG_ISIS_tag_restore_value(
        HISISDRV hDriver,
        AT_MODE nTag
);

Arguments:

Return Value:

Error count.

Supported Raster Image Formats:

This function does not process image pixels.

Remarks:

The IG_ISIS_tag_restore_value function restores the values last saved by a IG_ISIS_tag_save_value call, allowing an application to implement cancel or undo functions in settings dialogs so that previous values can be restored.

Use IG_ISIS_tag_restore_value to restore settings to the value(s) that existed when the application issued the most current IG_ISIS_tag_save_value call. If you do not wish to restore settings, then you must call IG_ISIS_tag_flush_value instead. Each call to IG_ISIS_tag_save_value must have a corresponding call to either IG_ISIS_tag_restore_value or IG_ISIS_tag_flush_value. This is a relatively new requirement, as multiple settings can now be saved in a stack. Previously, only one group of settings could be saved at a time, so only one call to IG_ISIS_tag_restore_value or IG_ISIS_tag_flush_value was required.

The value of nTag should correspond to the value of nTag that was used when the corresponding IG_ISIS_tag_save_value was called. The values are saved in a last-in/first-out stack. By saving the settings of all tags multiple times, it is possible to implement a nested set of settings dialogs, one of which can be cancelled to restore original settings, even after accepting the settings in a previous one. (See IG_ISIS_tag_save_value for a complete example.)

Example:

See the example for IG_ISIS_tag_flush_value.

See Also

IG_ISIS_tag_flush_value

IG_ISIS_tag_save_value