TODAYLISTITEM

4/8/2010

This structure contains information for a single Home screen item.

Syntax

typedef struct _TODAYLISTITEM {
  TCHAR szName[MAX_ITEMNAME];
  TODAYLISTITEMTYPE tlit;
  DWORD dwOrder;
  DWORD cyp;
  BOOL fEnabled;
  BOOL fOptions;
  DWORD grfFlags;
  TCHAR szDLLPath[MAX_PATH];
  HINSTANCE hinstDLL;
  HWND hwndCustom;
  BOOL fSizeOnDraw;
  BYTE * prgbCachedData;
  DWORD cbCachedData; 
} TODAYLISTITEMTYPE;

Members

• szName
  The name of the item. This is where the data for the item is stored in the registry.

  (HKEY_LOCAL_MACHINE\Software\Microsoft\Today\Items\<key name>).

  Value	Description
  MAX_ITEMNAME	Maximum number of characters in an item name.

• tlit
  The list item type. See TODAYLISTITEMTYPE.

• dwOrder
  A numerical order value. The items are sorted on the Home screen page according to their order value.

• cyp
  The height of the item in pixels.

• fEnabled
  TRUE if the item is checked in Home screen Settings and therefore visible on the Home screen. FALSE if the item is not check in the Home screen Settings and hidden.

• fOptions
  TRUE if the item has an Options screen in Settings (and implements TodayCustomItemDlgProc), otherwise FALSE.

• grfFlags
  Flags for the item (specific to each type). For custom items independent software vendors (ISVs) may use these flags any way they want.

• szDLLPath
  The path to the DLL for a custom item.

  Value	Description
  MAX_PATH	Maximum size of a path.

• hinstDLL
  Instance handle for the DLL (used to load dialogs, resources, and so on).

• hwndCustom
  The window handle for the custom item window.

• fSizeOnDraw
  Reserved. Used internally by the Home screen.

• prgbCachedData
  Pointer to the cached data. Custom items should use this to store data for which they don't want to query a database, the Internet, or some other bandwidth-intensive resource. The system will free this memory when it unloads the items due to setting changes, etc.

• cbCachedData
  Size of the cached data in bytes.

Remarks

This structure completely describes a Home screen item. It is passed by reference through the messages WM_TODAYCUSTOM_CLEARCACHE and WM_TODAYCUSTOM_QUERYREFRESHCACHE.

Requirements

See Also

Concepts

Home Screen Structures (Windows Mobile Professional)