FDO API Reference

Feature Data Objects

FdoParameter Class Reference

#include <Parameter.h>

Inherits FdoValueExpression.

Inheritance diagram for FdoParameter:

[legend]List of all members.

---

Detailed Description

The FdoParameter class derives from FdoValueExpression and represents a substitution parameter in the expression. FdoParameters are represented by a name: when expressions are evaluated, the caller must supply a value to be bound to each parameter name.

Remarks:

For information on how to set the value of a parameter, see the FdoICommand interface and FdoParameterValue.

Definition at line 37 of file Parameter.h.

Public Member Functions
FDO_API FdoString *	GetName ()
	Gets the name of the parameter.
FDO_API void	Process (FdoIExpressionProcessor *p)
	Overrides FdoExpression.Process to pass the FdoParameter to the appropriate expression processor operation.
FDO_API void	SetName (FdoString *value)
	Sets the name of the parameter.
FDO_API FdoString *	ToString ()
	Returns the well defined text representation of this expression.
Static Public Member Functions
FDO_API FdoParameter *	Create (FdoString *name)
	Constructs an instance of a parameter using the specified arguments.
FDO_API FdoParameter *	Create ()
	Constructs a default instance of a parameter.
Protected Member Functions
virtual void	Dispose ()
	Dispose this object.
	FdoParameter (FdoString *name)
	Constructs an instance of a parameter using the specified arguments.
	FdoParameter ()
	Constructs a default instance of a parameter.
virtual	~FdoParameter ()
	Default destructor for parameter.

---

Constructor & Destructor Documentation

FdoParameter::FdoParameter (   )  [protected]

Constructs a default instance of a parameter.

FdoParameter::FdoParameter (  FdoString *  name  )  [protected]

Constructs an instance of a parameter using the specified arguments.

virtual FdoParameter::~FdoParameter (   )  [protected, virtual]

Default destructor for parameter.

---

Member Function Documentation

FDO_API FdoParameter* FdoParameter::Create (  FdoString *  name  )  [static]

Constructs an instance of a parameter using the specified arguments. Parameters: name  Input parameter name Returns: Returns FdoParameter

FDO_API FdoParameter* FdoParameter::Create (   )  [static]

Constructs a default instance of a parameter. Returns: Returns FdoParameter

virtual void FdoParameter::Dispose (   )  [protected, virtual]

Dispose this object. Returns: Returns nothing Implements FdoIDisposable.

FDO_API FdoString* FdoParameter::GetName (   )

Gets the name of the parameter. Returns: Returns the parameter name

FDO_API void FdoParameter::Process (  FdoIExpressionProcessor *  p  )  [virtual]

Overrides FdoExpression.Process to pass the FdoParameter to the appropriate expression processor operation. Parameters: p  Input an FdoIExpressionProcessor Returns: Returns nothing Implements FdoExpression.

FDO_API void FdoParameter::SetName (  FdoString *  value  )

Sets the name of the parameter. Parameters: value  Input parameter name Returns: Returns nothing

FDO_API FdoString* FdoParameter::ToString (   )  [virtual]

Returns the well defined text representation of this expression. Returns: Returns the well defined text string Implements FdoExpression.

---

The documentation for this class was generated from the following file:

• Parameter.h

---

Comments or suggestions? Send us feedback.