Enumerator Definitions

IEnumNmConference::Clone

HRESULT Clone(
    [out] IEnumNmConference **ppEnum);

Creates a duplicate enumerator containing the same enumeration state as the current one.

Returns S_OK if successful, or E_POINTER if ppEnum is an invalid pointer.

ppEnum: Duplicate of the enumerator.

IEnumNmConference::Next

HRESULT Next(
    [in] ULONG cConference,
    [out] INmConference **rgpConference,
    [out] ULONG *pcFetched);

Retrieves the specified number of IEnumNmConference interfaces in the enumeration sequence.

Returns one of the following values:

S_OK Successful.
E_POINTER The rgpConference pointer is invalid.
S_FALSE There are no more IEnumNmConference interfaces to retrieve.
E_INVALIDARG pcFetched is NULL but cConference is not 1.

cConference: Number of IEnumNmConference interfaces to place in the rgpConference array.
rgpConference: Array in which to place IEnumNmConference interfaces.
pcFetched: Actual number of IEnumNmConference interfaces placed in the array. This may be set to NULL, in which case cConference must be 1.

The interfaces returned by this method have had their reference count incremented. The application should call the Release method on the interfaces to decrement the reference count when it has finished using the interfaces.

IEnumNmConference::Reset

HRESULT Reset();

Resets the enumeration sequence to the beginning.

Returns S_OK if successful.

This method affects the return value of the next call to the IEnumNmConference::Next method.

IEnumNmConference::Skip

HRESULT Skip(
    [in] ULONG cConference);

Skips a specified number of Conferences in the enumeration sequence.

Returns one of the following values:

S_OK Success.
E_INVALIDARG cConference is zero.
S_FALSE The cConference value exceeds the number of Conferences remaining in the enumeration.

cConference: Number of Conferences to skip.

This method affects the return value of the next call to the IEnumNmConference::Next method.

IEnumNmMember Interface

This enumerator interface enables you to access the list of Member objects. This enumerator is instantiated with the INmConference::EnumMember method or the INmChannel::EnumMember method. When instantiated, the Reset method is automatically called on the list.

IEnumNmMember::Clone

HRESULT Clone(
    [out] IEnumNmMember **ppEnum);

Creates a duplicate enumerator containing the same enumeration state as the current one.

Returns S_OK if successful, or E_POINTER if ppEnum is an invalid pointer.

ppEnum: Duplicate of the enumerator.

IEnumNmMember::Next

HRESULT Next(
    [in] ULONG cMember,
    [out] INmMember **rgpMember,
    [out] ULONG *pcFetched);

Retrieves the specified number of IEnumNmMember interfaces in the enumeration sequence.

Returns one of the following values:

S_OK Successful.
E_POINTER The rgpMember pointer is invalid.
S_FALSE There are no more Member objects to retrieve.
E_INVALIDARG pcFetched is NULL but cMember is not 1.

cMember: Number of IEnumNmMember interfaces to place in the rgpMember array.
rgpMember: Array in which to place IEnumNmMember interfaces.
pcFetched: Actual number of IEnumNmMember interfaces placed in the array. This may be set to NULL, in which case cMember must be 1.

IEnumNmMember::Reset

HRESULT Reset();

Resets the enumeration sequence to the beginning.

Returns S_OK if successful.

This method affects the return value of the next call to the IEnumNmMember::Next method.

IEnumNmMember::Skip

HRESULT Skip(
    [in] ULONG cMember);

Skips a specified number of Member objects in the enumeration sequence.

Returns one of the following values:

S_OK Success.
E_INVALIDARG cMember is zero.
S_FALSE The cMember value exceeds the number of Members remaining in the enumeration.

cMember: Number of Member objects to skip.

This method affects the return value of the next call to the IEnumNmMember::Next method.

IEnumNmChannel Interface

This enumerator interface enables you to access the list of Channel objects. This enumerator is instantiated with the INmConference::EnumChannel method. When instantiated, the Reset method is automatically called on the list.

This interface is useful for locating specific channels in a conference.

IEnumNmChannel::Clone

HRESULT Clone(
    [out] IEnumNmChannel **ppEnum);

Creates a duplicate enumerator containing the same enumeration state as the current one.

Returns S_OK if successful, or E_POINTER if ppEnum is an invalid pointer.

ppEnum: Duplicate of the enumerator.

IEnumNmChannel::Next

HRESULT Next(
    [in] ULONG cChannel,
    [out] INmChannel **rgpChannel,
    [out] ULONG *pcFetched);

Retrieves the specified number of IEnumNmChannel interfaces in the enumeration sequence.

Returns one of the following values:

S_OK Successful.
E_POINTER The rgpChannel pointer is invalid.
S_FALSE There are no more Channel objects to retrieve.
E_INVALIDARG pcFetched is NULL but cChannel is not 1.

cChannel: Number of IEnumNmChannel interfaces to place in the rgpChannel array.
rgpChannel: Array in which to place IEnumNmChannel interfaces.
pcFetched: Actual number of IEnumNmChannel interfaces placed in the array. This may be set to NULL, in which case cChannel must be 1.

IEnumNmChannel::Reset

HRESULT Reset();

Resets the enumeration sequence to the beginning.

Returns S_OK if successful.

This method affects the return value of the next call to the IEnumNmChannel::Next method.

IEnumNmChannel::Skip

HRESULT Skip(
    [in] ULONG cChannel);

Skips a specified number of Channel objects in the enumeration sequence.

Returns one of the following values:

S_OK Success.
E_INVALIDARG cChannel is zero.
S_FALSE The cChannel value exceeds the number of Channels remaining in the enumeration.

cChannel: Number of Channels to skip.

This method affects the return value of the next call to the IEnumNmChannel::Next method.

IEnumNmCall Interface

This enumerator interface enables you to access the list of Call objects being managed by the Conference Manager. This enumerator is instantiated with the INmManager::EnumCall method. When instantiated, the Reset method is automatically called on the list.

IEnumNmCall::Clone

HRESULT Clone(
    [out] IEnumNmCall **ppEnum);

Creates a duplicate enumerator containing the same enumeration state as the current one.

Returns S_OK if successful, or E_POINTER if ppEnum is an invalid pointer.

ppEnum: Duplicate of the enumerator.

IEnumNmCall::Next

HRESULT Next(
    [in] ULONG cCall,
    [out] INmCall **rgpCall,
    [out] ULONG *pcFetched);

Retrieves the specified number of IEnumNmCall interfaces in the enumeration sequence.

Returns one of the following values:

S_OK Successful.
E_POINTER The rgpCall pointer is invalid.
S_FALSE There are no more Call objects to retrieve.
E_INVALIDARG pcFetched is NULL but cCall is not 1.

cCall: Number of IEnumNmCall interfaces to place in the rgpCall array.
rgpCall: Array in which to place IEnumNmCall interfaces.
pcFetched: Actual number of IEnumNmCall interfaces placed in the array. This may be set to NULL, in which case cCall must be 1.

IEnumNmCall::Reset

HRESULT Reset();

Resets the enumeration sequence to the beginning.

Returns S_OK if successful.

This method affects the return value of the next call to the IEnumNmCall::Next method.

IEnumNmCall::Skip

HRESULT Skip(
    [in] ULONG cCall);

Skips a specified number of Call objects in the enumeration sequence.

Returns one of the following values:

S_OK Success.
E_INVALIDARG cCall is zero.
S_FALSE The cCall value exceeds the number of IEnumNmCall interfaces remaining in the enumeration.

cCall: Number of Call objects to skip.

This method affects the return value of the next call to the IEnumNmCall::Next method.

IEnumNmSharableApp Interface

This enumerator interface enables you to access the list of Shareable Applications in a conference. This enumerator is instantiated with the INmChannelAppshare::EnumEnumSharableApp method. When instantiated, the Reset method is automatically called on the list.

IEnumNmSharableApp::Clone

HRESULT Clone(
    [out] IEnumNmSharableApp **ppEnum);

Creates a duplicate enumerator containing the same enumeration state as the current one.

Returns S_OK if successful, or E_POINTER if ppEnum is an invalid pointer.

ppEnum: Duplicate of the enumerator.

IEnumNmSharableApp::Next

HRESULT Next(
    [in] ULONG cApp,
    [out] INmSharableApp **rgpApp,
    [out] ULONG *pcFetched);

Retrieves the specified number of IEnumNmSharableApp interfaces in the enumeration sequence.

Returns one of the following values:

S_OK Successful.
E_POINTER The rgpApp pointer is invalid.
S_FALSE There are no more Shareable Application objects to retrieve.
E_INVALIDARG pcFetched is NULL but cApp is not 1.

cApp: Number of IEnumNmSharableApp interfaces to place in the rgpApp array.
rgpApp: Array in which to place IEnumNmSharableApp interfaces.
pcFetched: Actual number of IEnumNmSharableApp interfaces placed in the array. This may be set to NULL, in which case cApp must be 1.

IEnumNmSharableApp::Reset

HRESULT Reset();

Resets the enumeration sequence to the beginning.

Returns S_OK if successful.

This method affects the return value of the next call to the IEnumNmSharableApp::Next method.

IEnumNmSharableApp::Skip

HRESULT Skip(
    [in] ULONG cApp);

Skips a specified number of Shareable Application objects in the enumeration sequence.

Returns one of the following values:

S_OK Success.
E_INVALIDARG cApp is zero.
S_FALSE The cApp value exceeds the number of Shareable Applications remaining in the enumeration.

cApp: Number of Application objects to skip.

This method affects the return value of the next call to the IEnumNmSharableApp::Next method.