FDO API Reference

Feature Data Objects

FdoPropertyValueCollection Class Reference

#include <PropertyValueCollection.h>

Inherits FdoCollection< FdoPropertyValue, FdoCommandException >.

Inheritance diagram for FdoPropertyValueCollection:

[legend]List of all members.

---

Detailed Description

FdoPropertyValueCollection represents a collection of property values. Property values are name/value pairs used for specifying the values of properties for insert and update commands.

Definition at line 34 of file PropertyValueCollection.h.

Public Member Functions
FDO_API FdoPropertyValue *	FindItem (FdoString *name)
	Finds 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 FdoPropertyValue *	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.
FDO_API FdoPropertyValue *	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.
Static Public Member Functions
FDO_API FdoPropertyValueCollection *	Create ()
	Constructs a default empty instance of an FdoPropertyValueCollection.
Protected Member Functions
virtual void	Dispose ()
	Dispose this object.
	FdoPropertyValueCollection ()
	Constructs a default empty instance of an FdoPropertyValueCollection.
virtual	~FdoPropertyValueCollection ()

---

Constructor & Destructor Documentation

FdoPropertyValueCollection::FdoPropertyValueCollection (   )  [inline, protected]

Constructs a default empty instance of an FdoPropertyValueCollection. Definition at line 39 of file PropertyValueCollection.h.

virtual FdoPropertyValueCollection::~FdoPropertyValueCollection (   )  [inline, protected, virtual]

Definition at line 43 of file PropertyValueCollection.h.

---

Member Function Documentation

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

Constructs a default empty instance of an FdoPropertyValueCollection. Returns: Returns FdoPropertyValueCollection

virtual void FdoPropertyValueCollection::Dispose (   )  [inline, protected, virtual]

Dispose this object. Returns: Returns nothing Implements FdoIDisposable. Definition at line 47 of file PropertyValueCollection.h.

FDO_API FdoPropertyValue* FdoPropertyValueCollection::FindItem (  FdoString *  name  )

Finds 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 of item Returns: Returns FdoPropertyValue

FDO_API FdoPropertyValue* FdoPropertyValueCollection::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 of item Returns: Returns FdoPropertyValue

FDO_API FdoPropertyValue* FdoPropertyValueCollection::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 of item Returns: Returns FdoPropertyValue

---

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

• PropertyValueCollection.h

---

Comments or suggestions? Send us feedback.