ImageGear for C and C++ on Windows v19.1 - Updated
IG_ISIS_drv_get_string
API Reference Guide > ISIS Component API Reference > ISIS Component Functions Reference > Driver Communication and Setup Functions > IG_ISIS_drv_get_string

Retrieve a string from a driver.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_ISIS_drv_get_string(
        HISISDRV hDriver,
        LONG lCode,
        LPSTR lpszBuffer
);

Arguments:

Name Type Description
hDriver HISISDRV The handle of the driver from which a string is to be retrieved.
lCode LONG The string code and driver number. lCode is split into a HIWORD and a LOWORD, as described under "Usage," below.
lpszBuffer LPSTR A pointer to a buffer that will contain the string returned by IG_ISIS_drv_get_string.

Return Value:

Error count.

Supported Raster Image Formats:

This function does not process image pixels.

Example:

The following example shows how to use IG_ISIS_drv_get_string to determine specific driver information:

 
Copy Code
/* Retrieve specific driver information     */
char Buf[132];IG_ISIS_drv_get_string(hDriver, MAKELONG(0, IG_ISIS_ATTR_VERSION), Buf);
printf("Version:   %s\n", Buf);IG_ISIS_drv_get_string(hDriver, MAKELONG(0, IG_ISIS_ATTR_NAME), Buf);
printf("Name:      %s\n", Buf);IG_ISIS_drv_get_string(hDriver, MAKELONG(0, IG_ISIS_ATTR_COPYRIGHT), Buf);
printf("Vendor:    %s\n", Buf);

This program fragment will produce a display similar to the following:

Version: FUJIGINE Version 1.39 Name: Fujitsu ScanPartner10 / M3096Gm / M3097Gm Copyright : Copyright 1994 Pixel Translations Incorporated

Remarks:

The IG_ISIS_drv_get_string function retrieves a string from a driver.

In most cases, lCode is filled in by the driver that issues an error. The HIWORD of lCode contains the string number (and is normally a negative value). The LOWORD of lCode can contain either a driver number or zero. If the LOWORD oflCode contains a driver number, then hDriver and any Links or Splits are searched to find a match for the LOWORD of lCode. The LOWORD of lCode can be set to zero (0) by the application, in which case a specific string is fetched from hDriver. The following specific strings are defined for all drivers:

lCode String
IG_ISIS_ATTR_VERSION Driver name and version
IG_ISIS_ATTR_NAME Long name of scanner
IG_ISIS_ATTR_COPYRIGHT Vendor and copyright of driver vendor

See Also:

IG_ISIS_drv_get_version