ImageGear for C and C++ on Windows v19.4 - Updated
IG_TWAIN_ctrl_get
API Reference Guide > TWAIN Component API Reference > TWAIN Component Functions Reference > General Functions > IG_TWAIN_ctrl_get

This function gets the value of a TWAIN control parameter.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_TWAIN_ctrl_get(
        AT_MODE nParamId,
        LPVOID lpValue,
        DWORD dwValueSize
);

Arguments:

Name Type Description
nParamId AT_MODE

Control parameter Id. Can be one of the following values:

  • IG_TW_CTRL_APP_NAME
  • IG_TW_CTRL_IMAGE_FILE_NAME
  • IG_TW_CTRL_AUDIO_FILE_NAME
  • IG_TW_CTRL_SAVE_PAGES_SEPARATELY
lpValue LPVOID Pointer to a memory buffer that receives the control parameter value.
dwValueSize DWORD The size of memory allocated for lpValue pointer.

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.