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

FdoArgumentDefinition Class Reference

#include <ArgumentDefinition.h>

Inherits FdoIDisposable.

Inheritance diagram for FdoArgumentDefinition:

[legend]
List of all members.

Detailed Description

The FdoArgumentDefinition class contains metadata that describes an argument to a function.

Definition at line 32 of file ArgumentDefinition.h.


Public Member Functions

FDO_API FdoDataType GetDataType ()
 Gets the FdoDataType of the argument.
FDO_API FdoStringGetDescription ()
 Gets a brief description of the argument.
FDO_API FdoStringGetName ()
 Gets the name of the argument.
FDO_API FdoPropertyType GetPropertyType ()
 Gets the FdoDataType of the argument.

Static Public Member Functions

FDO_API FdoArgumentDefinitionCreate (FdoString *name, FdoString *description, FdoPropertyType propertyType, FdoDataType dataType)
 Constructs an instance of an FdoArgumentDefinition using the specified arguments.
FDO_API FdoArgumentDefinitionCreate (FdoString *name, FdoString *description, FdoDataType dataType)
 Constructs an instance of an FdoArgumentDefinition using the specified arguments.

Protected Member Functions

virtual void Dispose ()
 Dispose this object.
 FdoArgumentDefinition ()
 Constructs an instance of an FdoArgumentDefinition with default properties.
 FdoArgumentDefinition (FdoString *name, FdoString *description, FdoPropertyType propertyType, FdoDataType dataType)
 Constructs an instance of an FdoArgumentDefinition using the specified arguments.
 FdoArgumentDefinition (FdoString *name, FdoString *description, FdoDataType dataType)
 Constructs an instance of an FdoArgumentDefinition using the specified arguments.
virtual ~FdoArgumentDefinition ()

Protected Attributes

FdoDataType m_dataType
wchar_t * m_description
wchar_t * m_name
FdoPropertyType m_propertyType

Constructor & Destructor Documentation

FdoArgumentDefinition::FdoArgumentDefinition FdoString name,
FdoString description,
FdoDataType  dataType
[protected]
 

Constructs an instance of an FdoArgumentDefinition using the specified arguments.

FdoArgumentDefinition::FdoArgumentDefinition FdoString name,
FdoString description,
FdoPropertyType  propertyType,
FdoDataType  dataType
[protected]
 

Constructs an instance of an FdoArgumentDefinition using the specified arguments.

FdoArgumentDefinition::FdoArgumentDefinition  )  [protected]
 

Constructs an instance of an FdoArgumentDefinition with default properties.

virtual FdoArgumentDefinition::~FdoArgumentDefinition  )  [protected, virtual]
 


Member Function Documentation

FDO_API FdoArgumentDefinition* FdoArgumentDefinition::Create FdoString name,
FdoString description,
FdoPropertyType  propertyType,
FdoDataType  dataType
[static]
 

Constructs an instance of an FdoArgumentDefinition using the specified arguments.

Parameters:
name Input the name of the argument.
description Input a brief description of the argument.
propertyType Input the property type of the argument
dataType Input the data type of the argument; This is used only if the argument's property type is FdoPropertyType_DataProperty.
Returns:
Returns FdoArgumentDefinition

FDO_API FdoArgumentDefinition* FdoArgumentDefinition::Create FdoString name,
FdoString description,
FdoDataType  dataType
[static]
 

Constructs an instance of an FdoArgumentDefinition using the specified arguments.

Parameters:
name Input the name of the argument.
description Input a brief description of the argument.
dataType Input the type of argument.
Returns:
Returns FdoArgumentDefinition

virtual void FdoArgumentDefinition::Dispose  )  [protected, virtual]
 

Dispose this object.

Returns:
Returns nothing

Implements FdoIDisposable.

FDO_API FdoDataType FdoArgumentDefinition::GetDataType  ) 
 

Gets the FdoDataType of the argument.

Returns:
Returns the data type of the argument; This is valid only if the argument's property type is FdoPropertyType_DataProperty.

FDO_API FdoString* FdoArgumentDefinition::GetDescription  ) 
 

Gets a brief description of the argument.

Returns:
Returns the argument description

FDO_API FdoString* FdoArgumentDefinition::GetName  ) 
 

Gets the name of the argument.

Returns:
Returns the argument name

FDO_API FdoPropertyType FdoArgumentDefinition::GetPropertyType  ) 
 

Gets the FdoDataType of the argument.

Returns:
Returns the property type of the argument

Member Data Documentation

FdoDataType FdoArgumentDefinition::m_dataType [protected]
 

Definition at line 121 of file ArgumentDefinition.h.

wchar_t* FdoArgumentDefinition::m_description [protected]
 

Definition at line 119 of file ArgumentDefinition.h.

wchar_t* FdoArgumentDefinition::m_name [protected]
 

Definition at line 118 of file ArgumentDefinition.h.

FdoPropertyType FdoArgumentDefinition::m_propertyType [protected]
 

Definition at line 120 of file ArgumentDefinition.h.


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