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

FdoParameterValueCollection Class Reference

#include <ParameterValueCollection.h>

Inherits FdoCollection< FdoParameterValue, FdoCommandException >.

Inheritance diagram for FdoParameterValueCollection:

[legend]
List of all members.

Detailed Description

The FdoParameterValueCollection class represents a collection of FdoParameterValue objects.

Definition at line 32 of file ParameterValueCollection.h.


Public Member Functions

FDO_API FdoParameterValueFindItem (FdoString *name)
 Gets the item in the collection with the specified name. Returns NULL if an item with the specified name does not exist in the collection.
FDO_API FdoParameterValueGetItem (FdoInt32 index)
 Gets the item in the collection at the specified index. Throws an invalid argument exception if the index is out of range.
FDO_API FdoParameterValueGetItem (FdoString *name)
 Gets the item in the collection with the specified name. Throws an invalid argument exception if an item with the specified name does not exist in the collection.

Static Public Member Functions

FDO_API FdoParameterValueCollectionCreate ()
 Constructs a default empty instance of an FdoParameterValueCollection.

Protected Member Functions

virtual void Dispose ()
 DOXYGEN-IGNORE

Member Function Documentation

FDO_API FdoParameterValueCollection* FdoParameterValueCollection::Create  )  [static]
 

Constructs a default empty instance of an FdoParameterValueCollection.

Returns:
Returns FdoParameterValueCollection

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

DOXYGEN-IGNORE

Implements FdoIDisposable.

FDO_API FdoParameterValue* FdoParameterValueCollection::FindItem FdoString name  ) 
 

Gets the item in the collection with the specified name. Returns NULL if an item with the specified name does not exist in the collection.

Parameters:
name Input name
Returns:
Returns FdoParameterValue

FDO_API FdoParameterValue* FdoParameterValueCollection::GetItem FdoInt32  index  ) 
 

Gets the item in the collection at the specified index. Throws an invalid argument exception if the index is out of range.

Parameters:
index Input index
Returns:
Returns FdoParameterValue

FDO_API FdoParameterValue* FdoParameterValueCollection::GetItem FdoString name  ) 
 

Gets the item in the collection with the specified name. Throws an invalid argument exception if an item with the specified name does not exist in the collection.

Parameters:
name Input name
Returns:
Returns FdoParameterValue

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