ImageGear for C and C++ on Windows v19.1 - Updated
IG_ISIS_env_get
API Reference Guide > ISIS Component API Reference > ISIS Component Functions Reference > General Functions > IG_ISIS_env_get

Read a value from an entry in the scanning configuration file.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_ISIS_env_get(
        LPSTR lpszRoot,
        LPSTR lpszDriver,
        LPSTR lpszKey,
        LPSTR lpszValue,
        WORD  wMax
);

Arguments:

Name Type Description
lpszRoot LPSTR This parameter is reserved and should always be zero.
lpszDriver LPSTR The name of the section in the configuration file that contains the specified entry.
lpszKey LPSTR The name of the entry whose value is to be read.
lpszValue LPSTR Pointer to a buffer that is to contain the value of the entry.
wMax WORD Specifies the size, in characters, of the buffer pointed to by lpszValue.

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:

IG_ISIS_env_get reads the value of an entry in the ISIS scanning configuration file SETSCAN.INI.

Use IG_ISIS_env_get to read from the scanning configuration file. If you are creating your own scanner selection dialog, you should read from and write to the same sections and entries used by the standard scanner selection dialog in order to ensure compatibility with other ISIS applications. For keeping track of non-scanning related parameters or those scanning parameters that are specific to your application, you should use your own custom INI file.

See Also

IG_ISIS_env_put