Programming Reference: ODDSEventMgrEnum

# Programming Reference

## ODDSEventMgrEnum

Class Definition File | ODDSConn.idl
Class C++ Binding | ODDSConn.xh

Class Hierarchy

    SOMObject
       ODDSEventMgrEnum

Description | This class contains a sequence of OpenDoc unique identifies that represents the event managers managed by an instance of the ODDSConnection and a cursor that moves through the sequence. This class uses the sequence to return event manager references. The ODDSConnection's CreateEventMgrEnum method must be used to create an ODDSEventMgrEnum object.

Methods

The methods defined by the ODDSEventMgrEnum class include:

- First
- Next

Overridden Methods | There are no methods overridden by the ODDSEventMgrEnum class.

### First

This method returns the first event manager in the sequence and positions the cursor to the second in the sequence.

Signature

    long First (ODDSEventMgr **eventMgr)

Parameters

eventMgr (ODDSEventMgr **) - output

  A reference to a reference to an event manager in which a reference to an event manager is returned.

Returns

- ODDS_ERROR_INVALID_PARAMETER
- ODDS_ERROR_INVALID_CURSOR
- ODDS_ERROR_END_RANGE

Remarks

This method returns a reference to the first sink in the event managers sink link and positions the cursor at the next item in this list.

Related Methods

- ODDSConnection::DeleteEventMgr

- ODDSEventMgrEnum::Next

### Next

This method returns a the next event manager in the sequence and positions the cursor to the next in the sequence.

Signature

    long Next (ODDSEventMgr **eventMgr)

Parameters

eventMgr (ODDSEventMgr **) - output

  A reference to a reference to an event manager in which a reference to an event manager is returned.

Returns

- ODDS_ERROR_INVALID_PARAMETER
- ODDS_ERROR_INVALID_CURSOR
- ODDS_ERROR_END_RANGE

Remarks

This method returns the next event manager and position the cursor at the next event manager in the sequence.

Related Methods

- ODDSEventMgr::DeleteEventMgr

- ODDSSinkEnum::First

[ Top | Previous | Next | Contents | Index | Documentation Homepage ]