ImageGear Professional DLL v18.1 for Windows
IG_TWAIN_cap_get
Send Feedback
ImageGear Professional v18.1 > API Reference Guide > TWAIN Component API Reference > TWAIN Component Functions Reference > Capability Functions > IG_TWAIN_cap_get

Glossary Item Box

This function gets information about a capability from a Data Source.

Declaration:

  Copy Code 
AT_ERRCOUNT ACCUAPI IG_TWAIN_cap_get(
        AT_LMODE nCap,
        AT_MODE nMsgId,
        LPHTWAINCAP lphTWAINCap
);

Arguments:

Name Type Description
nCap AT_LMODE The numeric designator of the capability (of the form IG_TW_CAP_xxxx, IG_TW_ICAP_xxxx, or IG_TW_ACAP_xxxx).
nMsgId AT_MODE

Message ID. Can be one of the following values:

  • IG_TW_MSG_GET - Get one or more capability values.
  • IG_TW_MSG_GETCURRENT - Get current capability value.
  • IG_TW_MSG_GETDEFAULT - Get default (e.g., power up) capability value.
lphTWAINCap LPHTWAINCAP Handle to the container of the requested capability. References the container structure where detailed information about the capability is stored.

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.

Remarks:

Use IG_TWAIN_source_open() to select the desired Data Source, prior to calling this function.

©2014. Accusoft Corporation. All Rights Reserved.