ImageGear for C and C++ on Linux v20.0 - Updated
API Reference Guide > Core Component API Reference > Core Component Functions Reference > Filter Functions > IG_fltr_ctrl_set

This function allows you to set a control parameter value for the specified format filter.


Copy Code
AT_ERRCODE ACCUAPI IG_fltr_ctrl_set(
   DWORD dwFormatID,
   const LPCHAR lpcsCtrlName,
   LPVOID lpValue,
   DWORD dwValueSize


Name Type Description
dwFormatID DWORD A constant indicating the format filter for which the control parameter should be set. See enumIGFormats for possible values.
lpcsCtrlName const LPCHAR Specifies the name of control parameter you want to set. The list of names of supported control parameters can be obtained using IG_fltr_ctrl_list.
lpValue LPVOID Specifies the new value for the control parameter. See Remarks.
dwValueSize DWORD Specifies the size (in bytes) of the control parameter value.

Return Value:

Returns 0 if successful. Otherwise, returns the number of ImageGear errors that occurred during this function call.

Supported Raster Image Formats:

This function does not process image pixels.


Copy Code
AT_ERRCOUNT nErrcount;            // Count of returned errors on stack
DWORD bufferSize = 32767;
// Get a type and a size of the control parameter
nErrcount = IG_fltr_ctrl_set(IG_FORMAT_TIF, "BUFFER_SIZE", (LPVOID)(AT_UINT)bufferSize, sizeof(bufferSize));


See File Formats Reference section for description of all control parameters supported by ImageGear file format filters.

Use IG_fltr_ctrl_list to get the list of supported control parameters for a specific format. Use IG_fltr_ctrl_get to get the information about a specific control parameter, as well as its current value.

The rules for passing values to this function are as follows:

See also the section Loading and Saving.

Is this page helpful?
Yes No
Thanks for your feedback.