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

Save current tag values in a file.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_ISIS_tag_save_file(
        HISISDRV hDriver,
        LPSTR lpszSection,
        LPSTR lpszFileName
);

Arguments:

Name Type Description
hDriver HISISDRV The handle to the driver.
lpszSection LPSTR Specifies the name of the [Section] in which to save the current values of all tags. [Section] is a standard *.INI file section name of the application's choosing. The name specified will be automatically enclosed in square brackets-do not include them in the lpszSection string. Note that if lpszSection is zero, the name pointed to by hDriver will be used as the section name.
lpszFileName LPSTR Specifies the name of the file in which to save the current tag values. If lpszFileName is zero, the name SETSCAN.INI is used, but an application-specific filename is recommended.

Return Value:

Error count.

Supported Raster Image Formats:

This function does not process image pixels.

Remarks:

The IG_ISIS_tag_save_file function saves the current values of all tags in a specified file. This allows an application to implement a Save Settings function and then later restore settings using the IG_ISIS_tag_restore_file function. This function is only supported on Windows platforms.

Use IG_ISIS_tag_save_file to save the current values of all tags in a file. Use this function to give the application the capability to save the current scanner settings, then use IG_ISIS_tag_restore_file to restore the settings at a later time.

By default, the settings file is saved from the current Windows directory (for example, C:\WINDOWS.). Passing a full path name specification in lpszFileName overrides this default.

Example:

The following call saves the current values of all tags in a section named for the particular scanner whose driver is currently loaded:

 
Copy Code
      IG_ISIS_tag_save_file(hDriver, 0, "PIXVIEW.INI");

See Also

IG_ISIS_tag_restore_file