FDO API Reference | Feature Data Objects |
#include <FunctionDefinition.h>
Inherits FdoIDisposable.
Inheritance diagram for FdoFunctionDefinition:
Definition at line 34 of file FunctionDefinition.h.
Public Member Functions | |
virtual FDO_API FdoBoolean | CanSetName () |
Indicates that this object allows its name to change. This function is defined so that this class can be a FdoNamedCollection element. | |
FDO_API FdoReadOnlyArgumentDefinitionCollection * | GetArguments () |
Gets an array of FdoArgumentDefinition objects required for the function. | |
FDO_API FdoString * | GetDescription () |
Gets a brief description of the function. | |
FDO_API FdoString * | GetName () |
Gets the name of the function. | |
FDO_API FdoPropertyType | GetReturnPropertyType () |
Gets the FdoPropertyType of the function return value. | |
FDO_API FdoDataType | GetReturnType () |
Gets the FdoDataType of the function return value. This is only valid if the function return property type is FdoPropertyType_DataProperty. | |
FDO_API FdoReadOnlySignatureDefinitionCollection * | GetSignatures () |
Gets an array of FdoSignatureDefinition objects that describe the different signatures supported by the function. | |
FDO_API bool | IsAggregate () |
Returns true if the function is an aggregate function and false if it is a simple function. | |
Static Public Member Functions | |
static FDO_API FdoFunctionDefinition * | Create (FdoString *name, FdoString *description, bool isAggregate, FdoSignatureDefinitionCollection *signatures) |
Constructs an instance of an FdoFunctionDefinition using the specified arguments. | |
static FDO_API FdoFunctionDefinition * | Create (FdoString *name, FdoString *description, FdoPropertyType returnPropertyType, FdoDataType returnType, FdoArgumentDefinitionCollection *arguments) |
Constructs an instance of an FdoFunctionDefinition using the specified arguments. | |
static FDO_API FdoFunctionDefinition * | Create (FdoString *name, FdoString *description, FdoDataType returnType, FdoArgumentDefinitionCollection *arguments) |
Constructs an instance of an FdoFunctionDefinition using the specified arguments. | |
Protected Attributes | |
wchar_t * | m_description |
bool | m_isAggregate |
wchar_t * | m_name |
FdoReadOnlySignatureDefinitionCollection * | m_signatures |
Comments or suggestions? Send us feedback. |