IFormProvider::GetMsgStatusIconIndex

4/8/2010

The GetMsgStatusIconIndex method returns the index to the appropriate icon in the symbol bitmap for the form library.

Syntax

HRESULT GetMsgStatusIconIndex (
  LPMAPIFOLDER pfldr,
  LPENTRYID pid,
  ULONG cbid,
  ULONG ffFlags,
  ULONG ffStatus,
  LPCWSTR pszMsgClass,
  ULONG cAttachments,
  ULONG * pnIndex
);

Parameters

  • pfldr
    [in] Reference to the folder for the message, specified by IMAPIFolder.
  • pid
    [in] Reference to the ID of the message, specified by the ENTRYID structure.
  • cbid
    [in] Count of bytes for the ID of the message.
  • ffStatus
    [in] Status of the message. See PR_MSG_STATUS for possible values.
  • pszMsgClass
    [in] Reference to the message class of the message.
  • cAttachments
    [in] Number of attachments for the message.
  • pnIndex
    [out] Reference to the index for the correct icon.

Return Value

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

  • S_OK
    Indicates success.

Remarks

For Windows Mobile 6.5 and later, the cbid parameter is forced to 0. You can pass-in a ceId instead of an EntryID, and just assume that its size (byte count) is the same as that of an EntryID structure.

Requirements

Header cemapi.h
Library cemapi.lib
Windows Embedded CE Windows CE 3.0 and later
Windows Mobile Pocket PC 2002 and later, Smartphone 2002 and later

See Also

Reference

IFormProvider

Other Resources

Messaging