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

FdoReadOnlyPropertyDefinitionCollection Class Reference

#include <ReadOnlyPropertyDefinitionCollection.h>

Inherits FdoReadOnlyCollection< FdoPropertyDefinition, FdoIDisposableCollection, FdoSchemaException >.

Inheritance diagram for FdoReadOnlyPropertyDefinitionCollection:

[legend]
List of all members.

Detailed Description

The FdoReadOnlyPropertyDefinitionCollection class represents a read-only collection of FdoPropertyDefinition objects.

Definition at line 37 of file ReadOnlyPropertyDefinitionCollection.h.


Public Member Functions

FDO_API bool Contains (FdoPropertyDefinition *value)
 Determines if the collection contains the specified item.
FDO_API FdoInt32 GetCount ()
 Gets the number of items in the collection.
FDO_API FdoPropertyDefinitionGetItem (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.
FDO_API FdoPropertyDefinitionGetItem (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 FdoInt32 IndexOf (FdoPropertyDefinition *value)
 Returns the index of the specified item in the collection. If the item does not exist, the IndexOf function returns -1.

Static Public Member Functions

FDO_API FdoReadOnlyPropertyDefinitionCollectionCreate (FdoPropertyDefinitionCollection *properties)
 Constructs and populates an instance of an FdoReadOnlyPropertyDefinitionCollection.

Protected Member Functions

virtual void Dispose ()
 Dispose this object.
 FdoReadOnlyPropertyDefinitionCollection (FdoPropertyDefinitionCollection *properties)
 FdoReadOnlyPropertyDefinitionCollection ()
 DOXYGEN-IGNORE

Constructor & Destructor Documentation

FdoReadOnlyPropertyDefinitionCollection::FdoReadOnlyPropertyDefinitionCollection  )  [inline, protected]
 

DOXYGEN-IGNORE

Definition at line 41 of file ReadOnlyPropertyDefinitionCollection.h.

FdoReadOnlyPropertyDefinitionCollection::FdoReadOnlyPropertyDefinitionCollection FdoPropertyDefinitionCollection properties  )  [protected]
 


Member Function Documentation

FDO_API bool FdoReadOnlyPropertyDefinitionCollection::Contains FdoPropertyDefinition value  ) 
 

Determines if the collection contains the specified item.

Parameters:
value Input FdoPropertyDefinition
Returns:
Returns true if the collection contains the specified item

FDO_API FdoReadOnlyPropertyDefinitionCollection* FdoReadOnlyPropertyDefinitionCollection::Create FdoPropertyDefinitionCollection properties  )  [static]
 

Constructs and populates an instance of an FdoReadOnlyPropertyDefinitionCollection.

Parameters:
properties Input collection of FdoPropertyDefinition objects
Returns:
Returns an FdoReadOnlyPropertyDefinitionCollection

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

Dispose this object.

Returns:
Returns nothing

Implements FdoIDisposable.

FDO_API FdoInt32 FdoReadOnlyPropertyDefinitionCollection::GetCount  )  [virtual]
 

Gets the number of items in the collection.

Returns:
Returns the number of items in the collection

Reimplemented from FdoReadOnlyCollection< FdoPropertyDefinition, FdoIDisposableCollection, FdoSchemaException >.

FDO_API FdoPropertyDefinition* FdoReadOnlyPropertyDefinitionCollection::GetItem FdoString name  )  [virtual]
 

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 to find
Returns:
Returns the item in the collection with the specified name

Reimplemented from FdoReadOnlyCollection< FdoPropertyDefinition, FdoIDisposableCollection, FdoSchemaException >.

FDO_API FdoPropertyDefinition* FdoReadOnlyPropertyDefinitionCollection::GetItem FdoInt32  index  )  [virtual]
 

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 the item in the collection at the specified index

Reimplemented from FdoReadOnlyCollection< FdoPropertyDefinition, FdoIDisposableCollection, FdoSchemaException >.

FDO_API FdoInt32 FdoReadOnlyPropertyDefinitionCollection::IndexOf FdoPropertyDefinition value  ) 
 

Returns the index of the specified item in the collection. If the item does not exist, the IndexOf function returns -1.

Parameters:
value Input FdoPropertyDefinition
Returns:
Returns the index of the specified item in the collection

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