Share via


Pocket Outlook Object Model API Registry Settings

Send Feedback

These registry settings are used for implementing source management and customization functionality. Source Providers and their associated Source ID's are part of a mechanism that supports per-provider customization of the PIM experience on Windows Mobile–based devices. A Source Provider is a custom function that customizes the PIM user experience. Typically, a Source Provider has a corresponding associate function that is responsible for synchronizing PIM data with the Windows Mobile–based device. Data synchronized with the Windows Mobile–based device by this associate function is marked with a Source identification tag (Source ID). When Outlook Mobile displays a PIM item, it checks to see if the item has a Source ID. If it finds one, it invokes the Source Provider, which customizes the user interface for the PIM item.

You register a Source Provider on a Windows Mobile–based device under the HKEY_LOCAL_MACHINE\System\PIMSources registry key, using the registry paths and values defined in the following tables.

      Entries     Registration type
\\HKLM
          Key
 
\System
        Key
   
\PIMSources
      Key
     
\<SourceID>
    Key
       
\Colors
  Key
         
\1
Entry
       
\Customizations
  Entry
       
\Type
  Entry
       
\CLSID
  Entry

Start by creating a <SourceID> sub-key under PIMSources. The sub-key name will be your Source ID. Choose a SourceID that follows the sequence 1, 2, 4, etc. (exactly one bit set).

Note   When you register your Source Provider, be sure that you create a Source ID that is not already in use on the Windows Mobile–based device. It is your responsibility to ensure that your registration does not collide with other sources.

The following table lists the constants that denote the registry paths, keys, and values you can use to programmatically register your Source Provider.

Name Value Type Description
PIMSRC_REGPATH_ROOT L"System\\PIMSources" REG_SZ The route for all Source Providers. A key called PIMSources is located under the protected-write key HKEY_LOCAL_MACHINE\System.
PIMSRC_REGPATH_COLORS L"Colors"

L"1"

REG_SZ

REG_DWORD

A subkey under the SourceID key. Include this subkey if you want your Source Provider to support alternate background colors for Appointments in the Agenda and Day views.

To specify the color you want, create an entry under this subkey, and give it the name "1" (from the PIMSRC_COLOR enumeration). The decimal value you assign to "1" represents the color. For example, a value of 65280 represents the color green, because the hexadecimal equivalent of 65280 is FF00 (Red:0, Green:255, Blue:0).

PIMSRC_REGVALUE_CLSID L"CLSID" REG_SZ An entry under the SourceID key. Its value represents the GUID of the COM class that implements you Source Provider.
PIMSRC_REGVALUE_CUSTOMIZATIONS L"Customizations" REG_DWORD An entry under the SourceID key. Its value describes the UI customizations that the Source Provider provides. This is the decimal equivalent of a bitmask that represents a combination of Source Provider Customization Type Flags.

For example, the decimal value 5 specifies that you support both customized Summary tabs and alternate icons.

PIMSRC_REGVALUE_TYPE L"Type" REG_DWORD An entry under the SourceID key. Its value describes the PIM items types that the Source Provider handles. This is the decimal equivalent of a bitmask that represents a combination of Source Provider PIM Type Ownership Flags.

For example, the decimal value 3 specifies that you support both Contact and Appointment items.

Remarks

When the user enters new PIM data on the Windows Mobile–based device, they will be able to select the Source Provider to use.

PIM items with a Source ID value of zero just use the default user interface.

As part of your Source Provider uninstall procedure, make sure that all PIM items associated with your Source Provider have their Source ID's changed to zero.

Requirements

Pocket PC: Pocket PC 2000 and later
Smartphone: Smartphone 2002 and later
OS Versions: Windows CE 3.0 and later
Header: pimstore.h
Library: pimstore.lib

See Also

Pocket Outlook Object Model API | PIMSRC_COLOR Enumeration | IPimSrcContactListIcon::Paint | IPimSrcContactSummaryCard::Display

Send Feedback on this topic to the authors

Feedback FAQs

© 2006 Microsoft Corporation. All rights reserved.