DTwainSource::EnumSupportedCaps

 Top  Previous  Next

Syntax

bool DTwainSource::EnumSupportedCaps( DTwainLongArray & CapsArray, int nWhich=CAPS_ALL ) const;

 

Parameters

CapsArray

On successful return, all of the supported capabilities are copied to the CapsArray vector.

 

nWhich

Flag that determines which capabilities are returned; regular, extended, custom or a combination of two or more of these types.

 

Return Value

Returns true if successful, false otherwise.

 

Comments

The CDTwainSource::EnumSupportedCaps returns all of the capabilities of the DTwainSource object.  The nWhich flag can be a Boolean OR of the following:

 

CAPS_REGULAR        

Return regular caps (not extended and not custom)

CAPS_EXTENDED        

Return extended caps

CAPS_CUSTOM        

Return custom caps

CAPS_ALL                

All capability types (REGULAR, CUSTOM, and EXTENDED)

 

For example, if you want to return both regular and extended capabilities, the call would be

 

DTwainSource Source;

DTwainLongArray CapArray;

...                // Assume Source has been opened

Source.EnumSupportedCaps(CapArray, CAPS_REGULAR | CAPS_EXTENDED);

...