Dynamsoft Home|Product Home

CapIfSupported Method

Description

Queries whether the Source supports a particular operation on the capability.

Syntax

Boolean ObjectName. CapIfSupported(Integer MessageType)

Parameters

Integer(enumerated value) MessageType: specifies the type of capability operation.

Value	Description
TWQC_GET (1)	If CapGet() is supported by the capability.
TWQC_SET (2)	If CapSet() is supported by the capability.
TWQC_GETDEFAULT (4)	If CapGetDefault() is supported by the capability.
TWQC_GETCURRENT (8)	If CapGetCurrent() is supported by the capability.
TWQC_RESET (16)	If CapReset() is supported by the capability.

Return value

Boolean.

TRUE indicates success. FALSE indicates failure.

When an error occurs and IfThrowException property is TRUE, an exception will be thrown.

When FALSE is returned or an exception is thrown, check ErrorCode property and ErrorString property for error information.

Remarks

The capability to query should be set in Capability property before calling CapIfSupported().

See also

Capability property, CapSet(), CapGet(), CapGetCurrent(), CapGetDefault(), CapReset()