ICatalogCollection interface

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.

Members

The ICatalogCollection interface inherits from the IDispatch interface. ICatalogCollection also has these types of members:

Methods

The ICatalogCollection interface has these methods.

MethodDescription
Add

Adds an item to the collection, giving it the high index value.

GetCollection

Retrieves a collection from the COM+ catalog that is related to the current collection.

GetUtilInterface

Retrieves the utility interface for the collection.

Populate

Populates the collection with data for all items contained in the collection.

PopulateByKey

Populates a selected list of items in the collection from the COM+ catalog, based on the specified keys.

PopulateByQuery

Reserved for future use.

Remove

Removes an item from the collection, given its index, and re-indexes the items with higher index values.

SaveChanges

Saves all pending changes made to the collection and the items it contains to the COM+ catalog data store.

 

Properties

The ICatalogCollection interface has these properties.

PropertyAccess typeDescription

_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 [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

ComAdmin.h

IDL

ComAdmin.Idl

See also

COMAdminCatalogCollection

 

 

Community Additions

ADD
Show: