FDO API Reference Feature Data Objects

FdoFunctionDefinition Class Reference

#include <FunctionDefinition.h>

Inherits FdoIDisposable.

Inheritance diagram for FdoFunctionDefinition:

Inheritance graph
[legend]
List of all members.

Detailed Description

The FdoFunctionDefinition class contains metadata that describes a function and its arguments.

Definition at line 33 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.

Static Public Member Functions

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 Member Functions

virtual void Dispose ()
 Dispose this object.
 FdoFunctionDefinition ()
 Constructs an instance of an FdoFunctionDefinition using default values.
 FdoFunctionDefinition (FdoString *name, FdoString *description, FdoPropertyType returnPropertyType, FdoDataType returnType, FdoArgumentDefinitionCollection *arguments)
 Constructs an instance of an FdoFunctionDefinition using the specified arguments.
 FdoFunctionDefinition (FdoString *name, FdoString *description, FdoDataType returnType, FdoArgumentDefinitionCollection *arguments)
 Constructs an instance of an FdoFunctionDefinition using the specified arguments.
virtual ~FdoFunctionDefinition ()

Protected Attributes

FdoReadOnlyArgumentDefinitionCollection * m_arguments
wchar_t * m_description
wchar_t * m_name
FdoDataType m_returnDataType
FdoPropertyType m_returnPropertyType
The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.