Share via


ICalContactLinkHandler::OnPhoneNumber

4/8/2010

A developer can customize what happens in response to a user selecting a phone number hyperlink in the calendar application. The developer must provide an event handler to implement the desired behavior. The event handler is this OnPhoneNumber method of the ICalContactLinkHandler interface.

When a user selects a phone number hyperlink with the Action key or by tapping the link, the VK_ACTION event is generated. When the calendar application receives this event, and there is a registered OnPhoneNumber event handler, the application invokes the handler. The application places information about the calendar item and the hyperlink into the parameters that it passes to the handler.

The handler need not handle all hyperlinks. If it is invoked for a hyperlink which it does not handle, it should return a status of E_FAIL. When the application sees this status it will provide default behavior.

For an overview of Action key customization, see Customizing Action Key Behavior for Calendar Hyperlinks.

Syntax

STDMETHOD (OnPhoneNumber)(
  LONG lApptId,
  LPCWSTR pwszPhonenum,
  DWORD cchPhonenum
)

Parameters

  • lApptId
    [in] The OID of the calendar item that contains the hyperlinked phone number.
  • pwszPhonenum
    [in] The phone number.
  • cchPhonenum
    [in] The number of characters in the phone number.

Return Value

This method returns the following values.

  • S_OK
    Indicates success.
  • E_FAIL
    Indicates failure. The calendar application will provide default behavior.

Requirements

Header cemapihandler.h
Windows Mobile Windows Mobile 6.5 and later

See Also

Reference

ICalContactLinkHandler
Pocket Outlook Object Model Registry Settings

Concepts

Customizing Action Key Behavior for Calendar Hyperlinks