IMessageFormHostEx::HOSTACTIONS

  • Article

4/8/2010

The HOSTACTIONS enumeration is used by IMessageFormHostEx::DoAction to specify the action to perform.

Syntax

enum HOSTACTIONS {
  HOSTACT_NULL                    =  0,
  HOSTACT_FIRST                   =  0,
  HOSTACT_REPLY                   =  1,
  HOSTACT_REPLY_TO_ALL            =  2,
  HOSTACT_FORWARD                 =  3,
  HOSTACT_DELETE                  =  4,
  HOSTACT_CLOSE                   =  5,
  HOSTACT_MOVE_TO_FOLDER          =  6,
  HOSTACT_GOTO_NEXT_MESSAGE       =  7,
  HOSTACT_GOTO_PREV_MESSAGE       =  8,
  HOSTACT_COMPOSE_NEW             =  9,
  HOSTACT_GET_FULL_MESSAGE        = 10,
  HOSTACT_VIEW_ATTACHMENT         = 11,
  HOSTACT_REPLY_WITH              = 12,
  HOSTACT_SHOW                    = 13,
  HOSTACT_MARK_AS_UNREAD          = 14,
  HOSTACT_VCARD_ACCEPT            = 15,
  HOSTACT_SET_FOLLOW_UP_FLAG      = 16,
  HOSTACT_COMPLETE_FOLLOW_UP_FLAG = 17,
  HOSTACT_CLEAR_FOLLOW_UP_FLAG    = 18,
  HOSTACT_TOGGLE_FOLLOW_UP_FLAG   = 19,
  HOSTACT_GET_HTML                = 20,
  HOSTACT_TOGGLE_ATTACHMENT       = 21,
  HOSTACT_LAST
};

Enumerators

  • HOSTACT_NULL
    Perform no operation.
  • HOSTACT_FIRST
    The placeholder that marks the first element in the enumeration range.
  • HOSTACT_REPLY
    Reply to the sender of this message.
  • HOSTACT_REPLY_TO_ALL
    Reply to sender of this message, and to all of the message's recipients.
  • HOSTACT_FORWARD
    Forward this message.
  • HOSTACT_DELETE
    Delete this message.
  • HOSTACT_CLOSE
    Close the message form.
  • HOSTACT_MOVE_TO_FOLDER
    Move this message to a folder.
  • HOSTACT_GOTO_NEXT_MESSAGE
    Go to the next message in the collection.
  • HOSTACT_GOTO_PREV_MESSAGE
    Go to the previous message in the collection.
  • HOSTACT_COMPOSE_NEW
    Compose a new message.
  • HOSTACT_GET_FULL_MESSAGE
    Mark this message for full download (not just the header).
  • HOSTACT_VIEW_ATTACHMENT
    Not supported.
  • HOSTACT_REPLY_WITH
    Not supported.
  • HOSTACT_SHOW
    Display the entire message.
  • HOSTACT_MARK_AS_UNREAD
    If the message has already been marked as READ, unmark it.
  • HOSTACT_VCARD_ACCEPT
    Accept the vCard that has arrived as an SMS attachment.
  • HOSTACT_SET_FOLLOW_UP_FLAG
    Mark the message for follow-up with a red flag.
  • HOSTACT_COMPLETE_FOLLOW_UP_FLAG
    Mark the message with a Completed flag.
  • HOSTACT_CLEAR_FOLLOW_UP_FLAG
    Remove any follow-up flag from this message.
  • HOSTACT_TOGGLE_FOLLOW_UP_FLAG
    If the message has no follow-up flag, or if it is marked with a Completed flag, then mark it for follow-up with a red flag. If the message already has a follow-up flag, then mark it with a Completed flag.
  • HOSTACT_GET_HTML
    Retrieve the Hypertext Markup Language (HTML) version of this Plain Text e-mail message.
  • HOSTACT_LAST
    The placeholder that marks the last element in the enumeration range.

  • HOSTACT_TOGGLE_ATTACHMENT
    This Host Action allows the Form Provider to request that the Form Host toggle a specific attachment for download.

    • If the specified attachment is already marked for download, it will be unmarked for download.
    • If it is not already marked for download, then it will be marked for download.

    Note

    Though it is possible for a Form Provider to toggle an attachment directly via CEMAPI, doing so can cause a Fetch–aware transport to immediately initiate a sync without regard for a user's desired roaming settings. It is recommended that you use HOSTACT_TOGGLE_ATTACHMENT to utilize the Form Host's existing roaming logic.

Example

The following code example demonstrates how to use HOSTACT_TOGGLE_ATTACHMENT. The form provider calls the IMessageFormHostEx::DoAction passing HOSTACT_TOGGLE_ATTACHMENT as the HOSTACTIONS act argument. The attachment index is specified as the DWORD flags member of the MESSAGEFIELDS *pMsgFields argument.

Note

To make the following code example easier to read, security checking and error handling are not included. This code example should not be used in a release configuration unless it has been modified to include them.

MESSAGEFIELDS mf = {0};

mf. flags = iAttach;

hr = pFormHost->DoAction(this, pMsg, HOSTACT_TOGGLE_ATTACHMENT, &mf);

Requirements

Header cemapi.h
Windows Embedded CE Windows CE .NET 4.2 and later
Windows Mobile Pocket PC for Windows Mobile 2003 and later, Smartphone for Windows Mobile 2003 and later

Remarks

For information on the vCard standard, visit the Internet Mail Consortium web site.

See Also

Reference

IMessageFormHostEx
IMessageFormHostEx::DoAction

Other Resources

Messaging