Programming Reference: ODDSSinkEnum

# Programming Reference

## ODDSSinkEnum

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

Class Hierarchy

    SOMObject
       ODDSSinkEnum

Description | This class contains a sequence of references to the sinks that connected to an event manager and a cursor that moves through the sequence. To create an ODDSSinkEnum object, use ODDSEventMgr's CreateSinkEnum method.

Methods

The methods defined by the ODDSSinkEnum class include:

- First
- Next

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

### First

This method returns a reference to the first sink in the sequence and positions the cursor to the second in the sequence.

Signature

    long First (ODDSSink **sink)

Parameters

sink (ODDSSink **) - output

  A reference to a reference to a sink in which a reference to a sink list is returned.

Returns

- ODDS_ERROR_INVALID_PARAMETER
- ODDS_ERROR_INVALID_CURSOR

Remarks

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

Related Methods

- ODDSEventMgr::CreateSinkEnum

- ODDSSinkEnum::Next

### Next

This method returns a reference to the next sink in the sequence and positions the cursor to the next in the sequence.

Signature

    long Next (ODDSSink **sink)

Parameters

sink (ODDSSink **) - output

  A reference to a reference to a sink in which a reference to a sink list is returned.

Returns

- ODDS_ERROR_INVALID_PARAMETER
- ODDS_ERROR_INVALID_CURSOR
- ODDS_ERROR_END_RANGE

Remarks

This method returns a reference to the next sink in the event managers sink link and positions the cursor at the next item in this list. If the next sink has been removed from the sink list, the ODDS_ERROR_INVALID_CURSOR message is returned and all subsequent Next method calls fail.

Related Methods

- ODDSEventMgr::CreateSinkEnum

- ODDSSinkEnum::First

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