Related Functions
ExampleAll Editions
Related Functions
Example
The IN_GetLayerProperties function returns information about the properties of the specified layer.
Syntax
int IN_GetLayerProperties( layerID, maxLen, cmdBuf, resultBuf )
|
Input Parameters |
Values |
Meaning |
|
IN_LAYER layerID |
layerID |
identifier of the layer |
|
int maxLen |
maximum size of the cmdBuf array in bytes. See Remarks. | |
|
CHARPTR cmdBuf |
numBits | numColors | grayScale |
number of bits | number of colors |Grayscale. See Remarks. |
|
Values |
Meaning | |
|
CHARPTR resultBuf |
numBits | numColors | grayScale |
result string. See Remarks. |
Remarks
This function inputs a string of property values about the specified layer and returns the corresponding values in the same order.
If maxLen is less than the length of resultBuf, a truncated result string is returned and a flag or error message, IN_WARN_BUFFER_TOO_SMALL (2), is given. This means that the result buffer is too small for the amount of data available.
cmdBuf is a string of input values to be tested. The delimiter between values is |. The values currently supported are numBits, numColors, and grayScale. The value string should be in quotation marks. If an unsupported value is entered, then NULL is returned. The values can be in any order.
The resultBuf returns the number of bits, the number of colors (ColorDepth), and if Grayscale is turned on (either 0 | 1 ) for the layer.
If a non raster format file is opened in Imagenation, then -1 is returned to indicate that it is an unknown value.
Release information
Added to Imagenation for Windows in Release 6.2.
Not yet available in Imagenation for UNIX.
See also