Restore saved tag values from a file.
Declaration:
 Copy Code |
|
|---|---|
AT_ERRCOUNT ACCUAPI IG_ISIS_tag_restore_file(
HISISDRV hDriver,
LPSTR lpszSection,
LPSTR lpszFileName
);
|
|
Arguments:
| hDriver | The handle to the driver. |
| lpszSection | Specifies the name of the [Section] from which to restore the previously-saved 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 | Specifies the name of the file from which to restore the tag values. If lpszFileName is zero, the name SETSCAN.INI is used, but an application-specific filename is recommended. |
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_restore_file function restores the values of all tags from a specified file. This allows an application to implement a Restore Settings function that restores previously-saved settings in one operation. This function is only supported on Windows platforms.
Use IG_ISIS_tag_restore_file to restore the values of all tags that were previously saved in a file by a call to IG_ISIS_tag_save_file. Use this function to give the application the capability to restore the saved scanner settings.
By default, the settings file is read from the current Windows directory (for example, C:\WINDOWS.). Passing a full path name specification in lpszFileName overrides this default.
Example:
The following call restores the settings previously saved by IG_ISIS_tag_save_file for the particular scanner whose driver is currently loaded:
| Copy Code |
|
|---|---|
IG_ISIS_tag_restore_file(hDriver, 0, "PIXVIEW.INI");
|
|