Represents any collection in the COM+ catalog. ICatalogCollection enables you to enumerate, add, remove, and retrieve items in a collection and to access related collections.
When To Implement
You do not need to implement the ICatalogCollection interface.
When To Use
The GetCollection methods of both the ICOMAdminCatalog and ICatalogCollection interfaces return pointers to an ICatalogCollection interface when you retrieve a collection. Use the ICatalogObject interface to represent and modify the items within a collection.
For information regarding the collections in the COM+ catalog, see COM+ Administration Collections.
For an introduction to programmatic administration of COM+, see Automating COM+ Administration.
Methods
The ICatalogCollection interface inherits the methods of the IDispatch interface.
In addition, ICatalogCollection defines the following methods.
| Method | Description |
|---|
get__NewEnum | Retrieves an enumerator that can be used to iterate through the collection objects.
|
get_Item | Retrieves the item that correspond to the specified index.
|
get_Count | Retrieves the number of items in the collection.
|
Remove |
Removes an item from the collection, given its index, and re-indexes the items with higher index values.
|
Add |
Adds an item to the collection, giving it the high index value.
|
Populate |
Populates the collection with data for all items contained in the collection.
|
SaveChanges |
Saves all pending changes made to the collection and the items it contains to the COM+ catalog data store.
|
GetCollection |
Retrieves a collection from the COM+ catalog that is related to the current collection.
|
get_Name | Retrieves the name of the collection.
|
get_AddEnabled | Indicates whether the Add method is enabled for the collection.
|
get_RemoveEnabled | Indicates whether the Remove method is enabled for the collection.
|
GetUtilInterface |
Retrieves the utility interface for the collection.
|
get_DataStoreMajorVersion | Retrieves the major version number of the catalog data store.
|
get_DataStoreMinorVersion | Retrieves the minor version number of the catalog data store.
|
PopulateByKey |
Populates a selected list of items in the collection from the COM+ catalog, based on the specified keys.
|
PopulateByQuery |
Reserved for future use.
|
Properties
The ICatalogCollection interface defines the following properties. The preceding table includes access methods for these properties.
| Property | Access type | Description |
|---|
_NewEnum | Read-only | An enumerator that can be used to iterate through the collection objects.
|
AddEnabled | Read-only | Indicates whether the Add method is enabled for the collection.
|
Count | Read-only | The number of items in the collection.
|
DataStoreMajorVersion | Read-only | The major version number of the catalog data store.
|
DataStoreMinorVersion | Read-only | The minor version number of the catalog data store.
|
Item | Read-only | The item that correspond to the specified index.
|
Name | Read-only | The name of the collection.
|
RemoveEnabled | Read-only | Indicates whether the Remove method is enabled for the collection.
|
Requirements
| Minimum supported client | Windows 2000 Professional |
|---|
| Minimum supported server | Windows 2000 Server |
|---|
| Header | ComAdmin.h |
|---|
| IDL | ComAdmin.Idl |
|---|
See Also
- COMAdminCatalogCollection
Send comments about this topic to Microsoft
Build date: 7/23/2009