com.jniwrapper.win32.shell
Interface IEnumIDList

All Superinterfaces:

com.jniwrapper.AutoDeleteParameter, com.jniwrapper.win32.com.IUnknown

All Known Implementing Classes:

IEnumIDListImpl

public interface IEnumIDList

extends com.jniwrapper.win32.com.IUnknown

Represents Java interface for COM interface IEnumIDList. Exposes a standard set of methods used to enumerate the pointers to item identifier lists (PIDLs) of the items in a Shell folder

Field Summary

static java.lang.String

INTERFACE_IDENTIFIER Interface identifier (IID) of the IEnumIDList

Method Summary

IEnumIDList	invokeClone() Creates a new item enumeration object with the same contents and state as the current one.
void	next(com.jniwrapper.UInt32 celt, com.jniwrapper.Pointer rgelt, com.jniwrapper.UInt32 pceltFetched) Retrieves the specified number of item identifiers in the enumeration sequence and advances the current position by the number of items retrieved.
void	reset() Returns to the beginning of the enumeration sequence.
void	skip(com.jniwrapper.UInt32 celt) Skips the specified number of elements in the enumeration sequence.

Methods inherited from interface com.jniwrapper.win32.com.IUnknown

addRef, isNull, queryInterface, release, setNull

Methods inherited from interface com.jniwrapper.AutoDeleteParameter

isAutoDelete, setAutoDelete

Field Detail

INTERFACE_IDENTIFIER

public static final java.lang.String INTERFACE_IDENTIFIER

Interface identifier (IID) of the IEnumIDList

See Also:

Constant Field Values

Method Detail

next

public void next(com.jniwrapper.UInt32 celt,
                 com.jniwrapper.Pointer rgelt,
                 com.jniwrapper.UInt32 pceltFetched)
          throws com.jniwrapper.win32.com.ComException

Retrieves the specified number of item identifiers in the enumeration sequence and advances the current position by the number of items retrieved.

Parameters:

celt - The number of elements in the array referenced by the rgelt parameter.

rgelt - A pointer to an array of ItemIDList pointers that receive the item identifiers.

pceltFetched - A pointer to a value that receives a count of the item identifiers actually returned in rgelt.

Throws:

com.jniwrapper.win32.com.ComException

skip

public void skip(com.jniwrapper.UInt32 celt)
          throws com.jniwrapper.win32.com.ComException

Skips the specified number of elements in the enumeration sequence.

Parameters:

celt - The number of item identifiers to skip.

Throws:

com.jniwrapper.win32.com.ComException

reset

public void reset()
           throws com.jniwrapper.win32.com.ComException

Returns to the beginning of the enumeration sequence.

Throws:

com.jniwrapper.win32.com.ComException

invokeClone

public IEnumIDList invokeClone()
                        throws com.jniwrapper.win32.com.ComException

Creates a new item enumeration object with the same contents and state as the current one.

Returns:

A new item enumeration object with the same contents and state as the current one.

Throws:

com.jniwrapper.win32.com.ComException