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

FdoParameterValue Class Reference

#include <ParameterValue.h>

Inherits FdoIDisposable.

Inheritance diagram for FdoParameterValue:

[legend]
List of all members.

Detailed Description

The FdoParameterValue class specifies a value for a particular parameter. Instances of this class are used to specify a value to bind to a parameter when a command is executed.

Definition at line 34 of file ParameterValue.h.


Public Member Functions

FDO_API FdoStringGetName ()
 Gets the parameter name the value should bind to as a string.
FDO_API FdoLiteralValueGetValue ()
 Gets the value to bind to the parameter as an FdoLiteralValue.
FDO_API void SetName (FdoString *value)
 Sets the parameter name the value should bind to as a string.
FDO_API void SetValue (FdoString *value)
 Sets the value to bind to the parameter as a string.
FDO_API void SetValue (FdoLiteralValue *value)
 Sets the value to bind to the parameter as an FdoLiteralValue.

Static Public Member Functions

FDO_API FdoParameterValueCreate (FdoString *name, FdoLiteralValue *value)
 Constructs an instance of an FdoParameterValue using the specified arguments.
FDO_API FdoParameterValueCreate (FdoString *name)
 Constructs an instance of an FdoParameterValue using the specified arguments.
FDO_API FdoParameterValueCreate ()
 Constructs a default instance of an FdoParameterValue.

Protected Member Functions

virtual void Dispose ()
 Dispose this object.
 FdoParameterValue (FdoString *name, FdoLiteralValue *value)
 Constructs an instance of a ParameterValue using the specified arguments.
 FdoParameterValue (FdoString *name)
 Constructs an instance of a ParameterValue using the specified arguments.
 FdoParameterValue ()
 Constructs a default instance of a ParameterValue.
virtual ~FdoParameterValue ()

Protected Attributes

wchar_t * m_name
 DOXYGEN-IGNORE
FdoLiteralValuem_value

Constructor & Destructor Documentation

FdoParameterValue::FdoParameterValue  )  [protected]
 

Constructs a default instance of a ParameterValue.

FdoParameterValue::FdoParameterValue FdoString name  )  [protected]
 

Constructs an instance of a ParameterValue using the specified arguments.

FdoParameterValue::FdoParameterValue FdoString name,
FdoLiteralValue value
[protected]
 

Constructs an instance of a ParameterValue using the specified arguments.

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


Member Function Documentation

FDO_API FdoParameterValue* FdoParameterValue::Create FdoString name,
FdoLiteralValue value
[static]
 

Constructs an instance of an FdoParameterValue using the specified arguments.

Parameters:
name Input name
value Input literal value
Returns:
Returns FdoParameterValue

FDO_API FdoParameterValue* FdoParameterValue::Create FdoString name  )  [static]
 

Constructs an instance of an FdoParameterValue using the specified arguments.

Parameters:
name Input name
Returns:
Returns FdoParameterValue

FDO_API FdoParameterValue* FdoParameterValue::Create  )  [static]
 

Constructs a default instance of an FdoParameterValue.

Returns:
Returns FdoParameterValue

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

Dispose this object.

Returns:
Returns nothing

Implements FdoIDisposable.

FDO_API FdoString* FdoParameterValue::GetName  ) 
 

Gets the parameter name the value should bind to as a string.

Returns:
Returns parameter name

FDO_API FdoLiteralValue* FdoParameterValue::GetValue  ) 
 

Gets the value to bind to the parameter as an FdoLiteralValue.

Returns:
Returns literal value

FDO_API void FdoParameterValue::SetName FdoString value  ) 
 

Sets the parameter name the value should bind to as a string.

Parameters:
value Input parameter name
Returns:
Returns nothing

FDO_API void FdoParameterValue::SetValue FdoString value  ) 
 

Sets the value to bind to the parameter as a string.

Parameters:
value Input string
Returns:
Returns nothing

FDO_API void FdoParameterValue::SetValue FdoLiteralValue value  ) 
 

Sets the value to bind to the parameter as an FdoLiteralValue.

Parameters:
value Input literal value
Returns:
Returns nothing

Member Data Documentation

wchar_t* FdoParameterValue::m_name [protected]
 

DOXYGEN-IGNORE

Definition at line 136 of file ParameterValue.h.

FdoLiteralValue* FdoParameterValue::m_value [protected]
 

Definition at line 137 of file ParameterValue.h.


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