DocList_GetNextItem

  • Article

4/8/2010

The DocList_GetNextItem macro retrieves the next item in the document list.

Syntax

DocList_GetNextItem (
    HWND hwnd, 
    int i, 
    UINT flags
);

Parameters

  • hwnd
    Handle to the document list view window.
  • i
    Index entry of the item.
  • flags
    Specifies the relationship to the item specified in iStart. See Remarks for more information about this parameter.

Return Value

This macro returns the index of the next list item if another list item is successfully found, or returns -1 if the next list item could not be identified (failure).

Remarks

The following value specifies the relationship of flags to the item specified in iStart.

Value Description

LVNI_ALL

Searches for a subsequent item by index (the default value).

The physical relationship of flags to iStart is specified with one of the following values.

Value Description

LVNI_ABOVE

Searches for an item that is above the specified item.

LVNI_BELOW

Searches for an item that is below the specified item.

LVNI_TOLEFT

Searches for an item to the left of the specified item.

LVNI_TORIGHT

Searches for an item to the right of the specified item.

The state of the item to find is specified with one or a combination of the following values of flag:

  • LVNI_CUT
    The item has the LVIS_CUT state flag set.
  • LVNI_DROPHILITED
    The item has the LVIS_DROPHILITED state flag set.
  • LVNI_FOCUSED
    The item has the LVIS_FOCUSED state flag set.
  • LVNI_SELECTED
    The item has the LVIS_SELECTED state flag set.

If an item does not have all of the specified state flags set, the search continues with the next item.

Requirements

Header doclist.h
Library doclist.lib
Windows Embedded CE Windows CE 3.0 and later
Windows Mobile Pocket PC 2002 and later