Configuration
[Client DLL]

Collaboration diagram for Configuration:

Classes

struct  TimeZone
 Timezone informations. More...
class  OutlookConfig
 Represents the configuration of Outlook client. More...

Defines

#define PROPERTY_USE_SUBFOLDERS   "useSubfolders"
 Client specific properties (see spdm/costants.h for common props).
#define PROPERTY_FOLDER_PATH   "folderPath"
#define PROPERTY_SCHEDULED_SYNC   "isScheduled"
#define PROPERTY_SOURCE_ORDER   "sourceOrder"
#define PROPERTY_FILTER_DATE_LOWER   "filterDateLower"
 Filtering properties.
#define PROPERTY_FILTER_DATE_UPPER   "filterDateUpper"
#define PROPERTY_FILTER_DATE_DIRECTION   "filterDateDirection"
#define PROPERTY_SP   "portal"
 This is stored in HKLM during install.
#define PROPERTY_INSTALLDIR   "installDir"
#define PROPERTY_FUNAMBOL_SWV   "funambol_swv"
#define PROPERTY_CUSTOMER   "Customer"
#define APPLICATION_URI   PROGRAM_NAME "/OutlookClient"
 Path in DMTree.
#define TIMEZONE_CONTEXT   L"SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Time Zones"

Typedefs

typedef struct TimeZone TimeZoneInformation
 Timezone informations.

Functions

 __declspec (dllexport) StringBuffer getOutlookVersion()
 Returns the installed MS Outlook name and version, as a string.
void createDefaultConfig ()
std::wstring pickOutlookFolder (const std::wstring &itemType)
 This function displays an Outlook window on desktop, to browse for a specific Outlook folder.
std::wstring getDefaultFolderPath (const std::wstring &itemType)
 Returns the full Outlook path of the default folder, given the desired 'itemType'.

Typedef Documentation

typedef struct TimeZone TimeZoneInformation

Timezone informations.

This is a more complete structure than 'TIME_ZONE_INFORMATION' because we need a unique key value to recognize the timezones ('keyName').


Function Documentation

__declspec ( dllexport   ) 

Returns the installed MS Outlook name and version, as a string.

Empty string in case of error.

Returns the installed MS Outlook name and version, as a string.

It's used to access the whole configuration object from UI, to get/set plugin properties. If configuration never instantiated, we need to initialize client first. (config could not exist, log must be opened)

Empty string in case of error.

References initializeClient(), and OutlookConfig::isInstantiated().

std::wstring getDefaultFolderPath ( const wstring &  itemType  ) 

Returns the full Outlook path of the default folder, given the desired 'itemType'.

Note:
to correctly manage COM library, we delete the ClientApplication instance at the end of this method (it's called from UI config window, Details).
Parameters:
itemType the type of items for the folder to select (CONTACT/TASK/...)
Returns:
path of default folder (empty string if errors).

References ClientApplication::getDefaultFolder(), ClientApplication::getInstance(), ClientFolder::getPath(), and manageClientException().

std::wstring pickOutlookFolder ( const wstring &  itemType  ) 

This function displays an Outlook window on desktop, to browse for a specific Outlook folder.

If passed 'itemType' is not an empty string, the user will have to select a folder of the correct type - otherwise a warning+retry will be displayed. The full path of folder will be returned.

Note:
to correctly manage COM library, we delete the ClientApplication instance at the end of this method (it's called from UI config window, Details).
Parameters:
itemType the type of items for the folder to select (CONTACT/TASK/...)
Returns:
path of folder selected (empty string if not selected).

References closeOutlook(), ClientApplication::getInstance(), ClientFolder::getPath(), manageClientException(), and ClientApplication::pickFolder().


Generated on Tue Dec 21 15:16:17 2010 for Funambol Outlook Plug-in Library by  doxygen 1.5.7.1