ImageGear Professional v18.2 > User Guide > Using ImageGear > Working with Global Control Parameters |
There is a set of parameters that is used to control the behavior of various portions of ImageGear, called "Global Control Parameters". Typically, your application program will not access these control parameters - they'll be set by the internal operation of ImageGear, and your application will not need to access them. The Global Control Parameter facility is quite general in purpose, however, and your application can use it to store (and later retrieve) any information desired. Also, in some situations your application program may need to set a Global Control Parameter to cause ImageGear to behave in a particular manner.
Each Global Control Parameter consists of:
The list of Global Control Parameters defined by ImageGear is as follows:
Parameter | Usage | ||
---|---|---|---|
LIC.PRODUCT_KEY | Product Key as defined in your License Key file. | ||
COMM.PATH | Default path to search for components. | ||
CPM.ENABLE_PROFILES | Enable/Disable color profiles. | ||
CPM.RGB_PROFILE_PATH | Filename for RGB color profile. | ||
CPM.CMYK_PROFILE_PATH | Filename for CMYK color profile. | ||
DIB.FILE_MAPPING.FLUSH_SIZE | Specifies the maximum size of a memory block in a DIB that can be processed without flushing the memory mapped file. Only used when "DIB.FILE_MAPPING.THRESHOLD" is greater than zero. Does not affect 1-bit images. See Working with Gigabyte-Sized Images. | ||
DIB.FILE_MAPPING.PATH | Specifies the path to a folder where memory mapped files will be stored. Only used when "DIB.FILE_MAPPING.THRESHOLD" is greater than zero. Does not affect 1-bit images. See Working with Gigabyte-Sized Images. | ||
DIB.FILE_MAPPING.THRESHOLD | Specifies minimum DIB size, in megabytes, for which the memory mapped file shall be used. Zero means that the use of memory mapped files is disabled. Does not affect 1-bit images. See Working with Gigabyte-Sized Images. | ||
FLTR.METADATA_FORMAT | Metadata format ("binary" or "text"). | ||
IGResult Object ::NotificationMode | IGCoreCtl Control.Result.NotificationFlags value. | ||
PDF.PDF_RESOURCE_PATH* | Path to the Resource\PDF directory. | ||
PDF.PS_RESOURCE_PATH* | Path to the Resource\PS directory. | ||
PDF.HOST_FONT_PATH* | Path to the system font directory. | ||
PDF.TMP_PATH* | Path to the TEMP directory. | ||
VECTOR.DEFAULT_FONT_FAMILY |
Specifies the typeface name used to display text objects, if the typeface is not defined in the source image.
Default Value: Empty string, which means that the default font will be selected by the system. Available Values: Any string |
* These parameters are not defined by default, but can be used for locating PDF resources.
Your application can access the Global Control Parameters via the IGCoreCtl Control.Settings Property. To create a new parameter, do the following:
Copy Code
|
|
---|---|
Dim gcp As IGGlobalParameter Object Set gcp = IGCoreCtl.CreateObject(IG_OBJ_GLOBAL_PARAM) gcp.Name = "MyApp.MaxFrammisSize" gcp.Info = "Maximum Frammis size for the MyApp application" Dim gcpvalue as IGDataItem Set gcpvalue = new IGDataItem gcpvalue.Type = IG_DATA_LONG gcpvalue.Long = 32767 Set gcp.Value = gcpvalue IGCoreCtl.Settings.UpdateParamFrom gcp |
To later get the value for the parameter created by the above code, do the following:
Copy Code
|
|
---|---|
Dim gcp As IGGlobalParameter Object
Set gcp =
IGCoreCtl.Settings.GetParamCopy("MyApp.MaxFrammisSize")
lMaxFrammisSize = gcp.Value.Long
|