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

FdoReadOnlyDataPropertyDefinitionCollection Class Reference

#include <ReadOnlyDataPropertyDefinitionCollection.h>

Inherits FdoReadOnlyCollection< FdoDataPropertyDefinition, FdoIDisposableCollection, FdoSchemaException >.

Inheritance diagram for FdoReadOnlyDataPropertyDefinitionCollection:

[legend]
List of all members.

Detailed Description

The FdoReadOnlyDataPropertyDefinitionCollection class represents a read-only collection of FdoDataPropertyDefinition objects.

Definition at line 37 of file ReadOnlyDataPropertyDefinitionCollection.h.


Public Member Functions

FDO_API bool Contains (FdoDataPropertyDefinition *value)
 Determines if the collection contains the specified item.
FDO_API FdoInt32 GetCount ()
 Gets the number of items in the collection.
FDO_API FdoDataPropertyDefinitionGetItem (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 FdoDataPropertyDefinitionGetItem (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 (FdoDataPropertyDefinition *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 FdoReadOnlyDataPropertyDefinitionCollectionCreate (FdoDataPropertyDefinitionCollection *properties)
 Constructs and populates an instance of an FdoReadOnlyDataPropertyDefinitionCollection.

Protected Member Functions

virtual void Dispose ()
 Dispose this object.
 FdoReadOnlyDataPropertyDefinitionCollection (FdoDataPropertyDefinitionCollection *properties)
 FdoReadOnlyDataPropertyDefinitionCollection ()
 DOXYGEN-IGNORE

Constructor & Destructor Documentation

FdoReadOnlyDataPropertyDefinitionCollection::FdoReadOnlyDataPropertyDefinitionCollection  )  [inline, protected]
 

DOXYGEN-IGNORE

Definition at line 41 of file ReadOnlyDataPropertyDefinitionCollection.h.

FdoReadOnlyDataPropertyDefinitionCollection::FdoReadOnlyDataPropertyDefinitionCollection FdoDataPropertyDefinitionCollection properties  )  [protected]
 


Member Function Documentation

FDO_API bool FdoReadOnlyDataPropertyDefinitionCollection::Contains FdoDataPropertyDefinition value  ) 
 

Determines if the collection contains the specified item.

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

FDO_API FdoReadOnlyDataPropertyDefinitionCollection* FdoReadOnlyDataPropertyDefinitionCollection::Create FdoDataPropertyDefinitionCollection properties  )  [static]
 

Constructs and populates an instance of an FdoReadOnlyDataPropertyDefinitionCollection.

Parameters:
properties Input collection of FdoDataPropertyDefinition objects
Returns:
Returns an FdoReadOnlyDataPropertyDefinitionCollection

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

Dispose this object.

Returns:
Returns nothing

Implements FdoIDisposable.

FDO_API FdoInt32 FdoReadOnlyDataPropertyDefinitionCollection::GetCount  )  [virtual]
 

Gets the number of items in the collection.

Returns:
Returns the number of items in the collection

Reimplemented from FdoReadOnlyCollection< FdoDataPropertyDefinition, FdoIDisposableCollection, FdoSchemaException >.

FDO_API FdoDataPropertyDefinition* FdoReadOnlyDataPropertyDefinitionCollection::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< FdoDataPropertyDefinition, FdoIDisposableCollection, FdoSchemaException >.

FDO_API FdoDataPropertyDefinition* FdoReadOnlyDataPropertyDefinitionCollection::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< FdoDataPropertyDefinition, FdoIDisposableCollection, FdoSchemaException >.

FDO_API FdoInt32 FdoReadOnlyDataPropertyDefinitionCollection::IndexOf FdoDataPropertyDefinition 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 FdoDataPropertyDefinition
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.