Enumerator Object

This section defines enumerator interfaces that take a snapshot of the current state.

IEnumIlsUser Interface

IEnumIlsNames Interface

IEnumIlsProtocol Interface

Back to ILS Reference

IEnumIlsUser Interface

This interface enables you to manipulate the users in the enumerated list.

Clone

Next

Reset

Skip

Back to Enumerator Object

IEnumIlsUser::Clone

HRESULT Clone(
    [out] IEnumIlsUser **ppEnumUser);

Creates another enumerator that contains the same enumeration state as the current one.

• Returns S_OK if successful, or ILS_E_MEMORY if unable to allocate enough memory for this request.

ppEnumUser

Indirect pointer to the enumeration interface on the Enumerator object. If the method is unsuccessful, this parameter's value is undefined.

Back to IEnumIlsUser Interface

Back to Enumerator Object

Back to ILS Object Listing

IEnumIlsUser::Next

HRESULT Next(
    [in] ULONG cUsers,
    [out] IIlsUser **rgpUsers,
    [out] ULONG *pcFetched);

Returns the next element in the list, starting at the current index.

• Returns one of the following values:

  S_OK	Success.
  S_FALSE	No more names in enumerator.
  ILS_E_POINTER	Address of output buffer is NULL.
  ILS_E_PARAMETER	Enumerator is empty.

cUsers

Number of elements requested.

rgpUsers

Address of an instance of the User object.

pcFetched

Number of elements received.

When the enumerated type is itself an interface pointer, this method must call AddRef through each pointer before return, and the client must later call Release through each pointer.

Back to IEnumIlsUser Interface

Back to Enumerator Object

Back to ILS Object Listing

IEnumIlsUser::Reset

HRESULT Reset();

Resets the enumeration sequence to the beginning.

• Returns S_OK if successful.

Back to IEnumIlsUser Interface

Back to Enumerator Object

Back to ILS Object Listing

IEnumIlsUser::Skip

HRESULT Skip(
    [in] ULONG cUsers);

Skips over a specified number of items in the enumeration sequence.

• Returns one of the following values:

  S_OK	Success.
  S_FALSE	No more names in enumerator.
  ILS_E_PARAMETER	Enumerator is empty.

cUsers

Number of elements to be skipped.

Back to IEnumIlsUser Interface

Back to Enumerator Object

Back to ILS Object Listing

IEnumIlsNames Interface

This interface enables you to manipulate the names in the enumerated list.

Clone

Next

Reset

Skip

Back to Enumerator Object

IEnumIlsNames::Clone

HRESULT Clone(
    [out] IEnumIlsNames **ppEnumName);

Creates another enumerator that contains the same enumeration state as the current one.

• Returns one of the following values:

  S_OK	Success.
  ILS_E_MEMORY	Unable to allocate enough memory for this request.
  ILS_E_POINTER	Return buffer is NULL.

ppEnumName

Indirect pointer to the enumeration interface on the Enumerator object. If the method is unsuccessful, this parameter's value is undefined.

Back to IEnumIlsNames Interface

Back to Enumerator Object

Back to ILS Object Listing

IEnumIlsNames::Next

HRESULT Next(
    [in] ULONG cNames,
    [out] BSTR *rgpbstrName,
    [out] ULONG *pcFetched);

Returns the next element in the list, starting at the current index.

• Returns one of the following values:

  S_OK	Success.
  S_FALSE	No more names in enumerator.
  ILS_E_POINTER	Address of the output buffer is NULL.
  ILS_E_PARAMETER	Enumerator is empty.

cNames

Number of elements requested.

rgpbstrName

Address of a string containing the name.

pcFetched

Number of elements received.

When the enumerated type is itself an interface pointer, this method must call AddRef through each pointer before return, and the client must later call Release through each pointer.

Back to IEnumIlsNames Interface

Back to Enumerator Object

Back to ILS Object Listing

IEnumIlsNames::Reset

HRESULT Reset();

Resets the enumeration sequence to the beginning.

• Returns S_OK if successful.

Back to IEnumIlsNames Interface

Back to Enumerator Object

Back to ILS Object Listing

IEnumIlsNames::Skip

HRESULT Skip(
    [in] ULONG cNames);

Skips over a specified number of items in the enumeration sequence.

• Returns one of the following values:

  S_OK	Success.
  S_FALSE	No more names in enumerator.
  ILS_E_PARAMETER	Enumerator is empty.

cNames

Number of elements to be skipped.

Back to IEnumIlsNames Interface

Back to Enumerator Object

Back to ILS Object Listing

IEnumIlsProtocol Interface

This interface enables you to manipulate the protocols in the enumerated list.

Clone

Next

Reset '

Skip

Back to Enumerator Object

IEnumIlsProtocol::Clone

HRESULT Clone(
    [out] IEnumIlsProtocol **ppEnumProtocol);

Creates another enumerator that contains the same enumeration state as the current one.

• Returns S_OK if successful, or ILS_E_MEMORY if unable to allocate enough memory for this request.

ppEnumProtocol

Indirect pointer to the enumeration interface on the Enumerator object. If the method is unsuccessful, this parameter's value is undefined.

Back to IEnumIlsProtocol Interface

Back to Enumerator Object

Back to ILS Object Listing

IEnumIlsProtocol::Next

HRESULT Next(
    [in] ULONG cProtocols,
    [out] IIlsProtocol **rgpProtocol,
    [out] ULONG *pcFetched);

Returns the next element in the list, starting at the current index.

• Returns one of the following values:

  S_OK	Success.
  S_FALSE	No more names in enumerator.
  ILS_E_POINTER	Address of output buffer is NULL.
  ILS_E_PARAMETER	Enumerator is empty.

cProtocols

Number of elements requested.

rgpProtocol

Address of an instance of the Protocol object.

pcFetched

Number of elements received.

When the enumerated type is itself an interface pointer, this method must call AddRef through each pointer before return, and the client must later call Release through each pointer.

Back to IEnumIlsProtocol Interface

Back to Enumerator Object

Back to ILS Object Listing

IEnumIlsProtocol::Reset

HRESULT Reset();

Resets the enumeration sequence to the beginning.

• Returns S_OK if successful.

Back to IEnumIlsProtocol Interface

Back to Enumerator Object

Back to ILS Object Listing

IEnumIlsProtocol::Skip

HRESULT Skip(
    [in] ULONG cProtocols);

Skips over a specified number of items in the enumeration sequence.

• Returns one of the following values:

  S_OK	Success.
  S_FALSE	No more names in enumerator.
  ILS_E_PARAMETER	Enumerator is empty.

cProtocols

Number of elements to be skipped.

Back to IEnumIlsProtocol Interface

Back to Enumerator Object

Back to ILS Object Listing

Last Updated: November 1, 1997
© 1997 Microsoft Corporation. All rights reserved. Terms of Use.