IPOutlookItemCollection::Item

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

The Item method retrieves an item from a folder, based on the current sort order.

Syntax

HRESULT Item(
   int iItem,
   IDispatch ** ppolItem
);

Parameters

• iItem
  [in] The one-based index for the item to retrieve. The index is the position of the item in the current sort order.

• ppolItem
  [out] Reference to the retrieved item. For information about IDispatch, see IDispatch.

Return Value

This method returns the standard values E_INVALIDARG, E_OUTOFMEMORY, E_UNEXPECTED, and E_FAIL, as well as the following:

• S_OK
  The method completed successfully.

Remarks

The GetItemIndexFromOid function returns a zerobased index value in its dwIndex parameter. Since the IPOutlookItemCollection::Item iItem argument takes a onebased index value, you will receive a "one-off" error when you pass this value to IPOutlookItemCollection::Item—unless you add 1 to it first.

Code Example

The following code example shows how to retrieve an item from an Items collection.

void GetAnItem(IPOutlookApp * polApp)
{
    IFolder                 * pFolder;
    IPOutlookItemCollection * pItems;
    ITask                   * pTask;

    // Get the fifth item in the Tasks folder.
    polApp->GetDefaultFolder(olFolderTasks, &pFolder);

    pFolder->get_Items(&pItems);

    pItems->Item(5,(IDispatch **)&pTask);

    // Do something with the Task ...

    // Release resources.
    pFolder->Release();
    pItems->Release();
    pTask->Release();
}

Remarks

If the value for iItem is less then zero, or greater than the number of item in this folder, then Item returns E_INVALIDARG.

Requirements

See Also

Tasks

Retrieving a PIM Item from the Outlook Mobile Database

Reference

Pocket Outlook Object Model Interfaces

Other Resources