IDSSTransactionTypes Interface Reference

List of all members.

---

Detailed Description

This automation interface is used to access the elements of a collection of transaction types on a change journal search object.

Public Member Functions
HRESULT	_NewEnum ([out, retval] IUnknown oppNewEnum)
	This standard property returns the enumerator object for the collection.
HRESULT	Add ([in] EnumDSSTransactionType iTransactionType)
	Add a new transaction type to the collection.
HRESULT	Clear ()
	Empty the collection.
HRESULT	Count ([out, retval] Int32 *opCount)
	The number of transaction types in the collection.
HRESULT	Item ([in] Int32 iIndex,[out, retval] EnumDSSTransactionType *opTransactionType)
	Return the transaction type at the given index from the collection.
HRESULT	Remove ([in] EnumDSSTransactionType iTransactionType)
	Remove an existing transaction type from the collection.

---

Member Function Documentation

HRESULT IDSSTransactionTypes::_NewEnum (  [out, retval] IUnknown   oppNewEnum  )

This standard property returns the enumerator object for the collection. Calling methods on the enumerator object retrieves the elements of the collection as variants. Parameters: oppNewEnum  An IUnknown pointer to the enumerator object. The elements are returned using the standard IEnumVARIANT interface. Returns: Usual COM result code: S_OK

HRESULT IDSSTransactionTypes::Add (  [in] EnumDSSTransactionType  iTransactionType  )

Add a new transaction type to the collection. Since the collection has set semantics each transaction type can appear at most once in the collection. Subsequent attempts to add a transaction type that already exists in the collection will be ignored. Parameters: iTransactionType  The transaction type to be added to the collection. Returns: Usual COM result code: S_OK

HRESULT IDSSTransactionTypes::Clear (   )

Empty the collection. Returns: Usual COM result code: S_OK

HRESULT IDSSTransactionTypes::Count (  [out, retval] Int32 *  opCount  )

The number of transaction types in the collection. Parameters: opCount  The number of transaction types in the collection. Returns: Usual COM result code: S_OK

HRESULT IDSSTransactionTypes::Item (  [in] Int32  iIndex, [out, retval] EnumDSSTransactionType *  opTransactionType )

Return the transaction type at the given index from the collection. The first element in the collection has index 1. Parameters: iIndex  Index of the desired item in the collection. opTransactionType  The transaction type at index iIndex in the collection. Returns: Usual COM result code: E_INVALIDARG The index does not identify an element of the collection. S_OK

HRESULT IDSSTransactionTypes::Remove (  [in] EnumDSSTransactionType  iTransactionType  )

Remove an existing transaction type from the collection. Attempts to remove a transaction type that is not in the collection will be ignored. Parameters: iTransactionType  The transaction type to be removed from the collection. Returns: Usual COM result code: S_OK

---