FDO API Reference Feature Data Objects
Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

FdoICommandCapabilities Class Reference

#include <ICommandCapabilities.h>

Inherits FdoIDisposable.

Inheritance diagram for FdoICommandCapabilities:

[legend]
List of all members.

Detailed Description

The FdoICommandCapabilities interface declares the feature provider's level of support for Commands.

Definition at line 31 of file ICommandCapabilities.h.


Public Member Functions

virtual FDO_API FdoInt32GetCommands (FdoInt32 &size)=0
 Gets an array of the FdoCommandType values supported by the feature provider.
virtual FDO_API bool SupportsParameters ()=0
 Determines if commands support parameterization.
virtual FDO_API bool SupportsSelectDistinct ()=0
 Determines if Distinct can be used with SelectAggregates. This can be true only if the SelectAggregates command is supported by the provider.
virtual FDO_API bool SupportsSelectExpressions ()=0
 Determines if the feature provider can use expressions for properties with Select and SelectAggregate commands.
virtual FDO_API bool SupportsSelectFunctions ()=0
 Determines if simple functions can be used in Select and SelectAggregates command. Aggregate functions can only be used in the SelectAggregates command. Capability for using SelectAggregates is found in CommandCapabilities.
virtual FDO_API bool SupportsSelectGrouping ()=0
 Determines if a grouping criteria is available in the SelectAggregates command. This can be true only if the SelectAggregates command is supported by the provider.
virtual FDO_API bool SupportsSelectOrdering ()=0
 Determines if ordering is available in the Select and SelectAggregates command.
virtual FDO_API bool SupportsTimeout ()=0
 Determines if the feature provider supports command execution timeout.

Member Function Documentation

virtual FDO_API FdoInt32* FdoICommandCapabilities::GetCommands FdoInt32 size  )  [pure virtual]
 

Gets an array of the FdoCommandType values supported by the feature provider.

Parameters:
size Output the number of commands
Returns:
Returns the list of commands

virtual FDO_API bool FdoICommandCapabilities::SupportsParameters  )  [pure virtual]
 

Determines if commands support parameterization.

Returns:
Returns true if commands support parameterization

virtual FDO_API bool FdoICommandCapabilities::SupportsSelectDistinct  )  [pure virtual]
 

Determines if Distinct can be used with SelectAggregates. This can be true only if the SelectAggregates command is supported by the provider.

Returns:
Returns true if the feature provider supports select distinct.

virtual FDO_API bool FdoICommandCapabilities::SupportsSelectExpressions  )  [pure virtual]
 

Determines if the feature provider can use expressions for properties with Select and SelectAggregate commands.

Returns:
Returns true if the feature provider supports select expressions.

virtual FDO_API bool FdoICommandCapabilities::SupportsSelectFunctions  )  [pure virtual]
 

Determines if simple functions can be used in Select and SelectAggregates command. Aggregate functions can only be used in the SelectAggregates command. Capability for using SelectAggregates is found in CommandCapabilities.

Returns:
Returns true if the feature provider supports select simple functions.

virtual FDO_API bool FdoICommandCapabilities::SupportsSelectGrouping  )  [pure virtual]
 

Determines if a grouping criteria is available in the SelectAggregates command. This can be true only if the SelectAggregates command is supported by the provider.

Returns:
Returns true if the feature provider supports select grouping.
Note:
Aggregate functions can be supported without also supporting grouping criteria (but not vice versa).

virtual FDO_API bool FdoICommandCapabilities::SupportsSelectOrdering  )  [pure virtual]
 

Determines if ordering is available in the Select and SelectAggregates command.

Returns:
Returns true if the feature provider supports select ordering.

virtual FDO_API bool FdoICommandCapabilities::SupportsTimeout  )  [pure virtual]
 

Determines if the feature provider supports command execution timeout.

Returns:
Returns true if the feature provider supports timeout.

The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.