FDO API Reference | Feature Data Objects |
#include <FunctionDefinition.h>
Inherits FdoIDisposable.
Inheritance diagram for FdoFunctionDefinition:
Definition at line 35 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. | |
virtual FDO_API FdoFunctionCategoryType | GetFunctionCategoryType () |
Returns the category for the function described in the current function definition. | |
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 | |
FDO_API FdoFunctionDefinition * | Create (FdoString *name, FdoString *description, bool isAggregate, FdoSignatureDefinitionCollection *signatures, FdoFunctionCategoryType functionCategoryType=FdoFunctionCategoryType_Unspecified) |
Constructs an instance of an FdoFunctionDefinition using the specified arguments. | |
FDO_API FdoFunctionDefinition * | Create (FdoString *name, FdoString *description, FdoPropertyType returnPropertyType, FdoDataType returnType, FdoArgumentDefinitionCollection *arguments, FdoFunctionCategoryType functionCategoryType=FdoFunctionCategoryType_Unspecified) |
Constructs an instance of an FdoFunctionDefinition using the specified arguments. | |
FDO_API FdoFunctionDefinition * | Create (FdoString *name, FdoString *description, FdoDataType returnType, FdoArgumentDefinitionCollection *arguments, FdoFunctionCategoryType functionCategoryType=FdoFunctionCategoryType_Unspecified) |
Constructs an instance of an FdoFunctionDefinition using the specified arguments. | |
Protected Member Functions | |
virtual void | Dispose () |
Dispose this object. | |
FdoFunctionDefinition () | |
Constructs an instance of an FdoFunctionDefinition using default values. | |
FdoFunctionDefinition (FdoString *name, FdoString *description, bool isAggregate, FdoSignatureDefinitionCollection *signatures, FdoFunctionCategoryType functionCategoryType) | |
Constructs an instance of an FdoFunctionDefinition using the specified arguments. | |
FdoFunctionDefinition (FdoString *name, FdoString *description, FdoPropertyType returnPropertyType, FdoDataType returnType, FdoArgumentDefinitionCollection *arguments, FdoFunctionCategoryType functionCategoryType) | |
Constructs an instance of an FdoFunctionDefinition using the specified arguments. | |
FdoFunctionDefinition (FdoString *name, FdoString *description, FdoDataType returnType, FdoArgumentDefinitionCollection *arguments, FdoFunctionCategoryType functionCategoryType) | |
Constructs an instance of an FdoFunctionDefinition using the specified arguments. | |
virtual | ~FdoFunctionDefinition () |
Protected Attributes | |
wchar_t * | m_description |
FdoFunctionCategoryType | m_functionCategoryType |
bool | m_isAggregate |
wchar_t * | m_name |
FdoReadOnlySignatureDefinitionCollection * | m_signatures |
|
Constructs an instance of an FdoFunctionDefinition using the specified arguments.
|
|
Constructs an instance of an FdoFunctionDefinition using the specified arguments.
|
|
Constructs an instance of an FdoFunctionDefinition using the specified arguments.
|
|
Constructs an instance of an FdoFunctionDefinition using default values.
|
|
|
|
Indicates that this object allows its name to change. This function is defined so that this class can be a FdoNamedCollection element.
Definition at line 202 of file FunctionDefinition.h. References FDO_API, and FdoBoolean. |
|
Constructs an instance of an FdoFunctionDefinition using the specified arguments.
|
|
Constructs an instance of an FdoFunctionDefinition using the specified arguments.
|
|
Constructs an instance of an FdoFunctionDefinition using the specified arguments.
|
|
Dispose this object.
Implements FdoIDisposable. |
|
Gets an array of FdoArgumentDefinition objects required for the function.
|
|
Gets a brief description of the function.
|
|
Returns the category for the function described in the current function definition.
Definition at line 226 of file FunctionDefinition.h. References FDO_API, and FdoFunctionCategoryType. |
|
Gets the name of the function.
|
|
Gets the FdoPropertyType of the function return value.
|
|
Gets the FdoDataType of the function return value. This is only valid if the function return property type is FdoPropertyType_DataProperty.
|
|
Gets an array of FdoSignatureDefinition objects that describe the different signatures supported by the function.
|
|
Returns true if the function is an aggregate function and false if it is a simple function.
|
|
Definition at line 234 of file FunctionDefinition.h. |
|
Definition at line 236 of file FunctionDefinition.h. |
|
Definition at line 232 of file FunctionDefinition.h. |
|
Definition at line 233 of file FunctionDefinition.h. |
|
Definition at line 235 of file FunctionDefinition.h. |
Comments or suggestions? Send us feedback. |