Software and Services, Portable Libraries  2019.Mar.01
A library for managing digital certificates
iCalendarApi Interface Reference

Public Types

typedef UINT64 CalendarID
 Type ID for any Calendar Store. More...
 
typedef UINT64 CalendarStoreID
 Define the data types. More...
 
typedef UINT64 ComponentID
 Type ID for a specific calendar. More...
 
typedef UINT64 ParameterID
 Type ID for a specific property in a component. More...
 
typedef UINT64 PropertyID
 Type ID for a specific component in a calendar. More...
 

Public Member Functions

HRESULT ApiFinialize ()
 When finished, to free up any used resources. More...
 
HRESULT ApiInitialize ()
 Type ID for a specific parameter in a property. More...
 
HRESULT ApiVersion ([out] UINT32 *Version)
 Get the API version. More...
 
HRESULT CalendarClose ([in] CalendarStoreID CalStoreID)
 Close a calendar. More...
 
HRESULT CalendarOpen ([in] const char *url, [out] CalendarStoreID *CalStoreID)
 Open a calendar via a supported URL type. More...
 
HRESULT PasswordSafeCreate ([in] const char *masterPassword, [in] const char *directory, [out] boolean *results)
 Create a password safe for caching connection information during synchronization processes. More...
 
HRESULT PasswordSafeOpen ([in] const char *masterPassword, [in] const char *directory, [out] boolean *results)
 Open an existing password safe. More...
 

Detailed Description

Definition at line 57 of file iCalendarApi.idl.

Member Typedef Documentation

◆ CalendarID

typedef UINT64 iCalendarApi::CalendarID

Type ID for any Calendar Store.

Definition at line 63 of file iCalendarApi.idl.

◆ CalendarStoreID

Define the data types.

Definition at line 62 of file iCalendarApi.idl.

◆ ComponentID

typedef UINT64 iCalendarApi::ComponentID

Type ID for a specific calendar.

Definition at line 64 of file iCalendarApi.idl.

◆ ParameterID

typedef UINT64 iCalendarApi::ParameterID

Type ID for a specific property in a component.

Definition at line 66 of file iCalendarApi.idl.

◆ PropertyID

typedef UINT64 iCalendarApi::PropertyID

Type ID for a specific component in a calendar.

Definition at line 65 of file iCalendarApi.idl.

Member Function Documentation

◆ ApiFinialize()

HRESULT iCalendarApi::ApiFinialize ( )

When finished, to free up any used resources.

◆ ApiInitialize()

HRESULT iCalendarApi::ApiInitialize ( )

Type ID for a specific parameter in a property.

Initialize the interface, must be called once prior to any other API call.

◆ ApiVersion()

HRESULT iCalendarApi::ApiVersion ( [out] UINT32 *  Version)

Get the API version.

Parameters
Versionthe API version will be placed in this variable.

◆ CalendarClose()

HRESULT iCalendarApi::CalendarClose ( [in] CalendarStoreID  CalStoreID)

Close a calendar.

Parameters
CalStoreIDThe ID of the calendar to close.

◆ CalendarOpen()

HRESULT iCalendarApi::CalendarOpen ( [in] const char *  url,
[out] CalendarStoreID CalStoreID 
)

Open a calendar via a supported URL type.

Parameters
urlThe url of where to load the calendar.
CalStoreIDThe returned value of the opened calendar.

◆ PasswordSafeCreate()

HRESULT iCalendarApi::PasswordSafeCreate ( [in] const char *  masterPassword,
[in] const char *  directory,
[out] boolean *  results 
)

Create a password safe for caching connection information during synchronization processes.

So the user does not have to re-enter the same user name and password repeatedly. Do not use the password safe if you do not want the authentication information cached.

Parameters
masterPasswordThe master password for the password safe. The user will be asked for each password safes password, once per session (when cashed authentication information is used).
directoryThe location of this password safe.
ResultsWill be set to TRUE if successful.

◆ PasswordSafeOpen()

HRESULT iCalendarApi::PasswordSafeOpen ( [in] const char *  masterPassword,
[in] const char *  directory,
[out] boolean *  results 
)

Open an existing password safe.

Parameters
masterPasswordThe master password that allows access to all other passwords.
directoryThe directory where the password safe is located.
See also
PwSafeCreate()
Returns
TRUE Returns TRUE if the supplied password was correct and path exists.

The documentation for this interface was generated from the following file: