4
Types, Constants and Capabilities

Types

Typedefs

typedef void *  CAPISession 
typedef void *  CAPIHandle 
typedef void *  CAPIStream 
typedef unsigned long  CAPIStatus 
typedef unsigned long  CAPIFlag 
typedef unsigned long CAPIFlag  

CAPIFlag Constants

CAPI_FLAG_FETCH_EXCLUDE_APPOINTMENTS

Used with CAPI_FetchEvent* calls to exclude regular meetings (appointments).

CAPI_FLAG_FETCH_EXCLUDE_DAILYNOTES

Used with CAPI_FetchEvent* calls to exclude daily notes.

CAPI_FLAG_FETCH_EXCLUDE_DAYEVENTS

Used with CAPI_FetchEvent* calls to exclude day events.

CAPI_FLAG_FETCH_EXCLUDE_HOLIDAYS

Used with CAPI_FetchEvent* calls to exclude holidays.

CAPI_FLAG_NONE

Used to select the default behaviour.

CAPI_FLAG_STORE_DELPROPS

Used with CAPI_Store* functions to specify that the supplied properties are to be cleared or deleted on the server.

CAPI_FLAG_STORE_MODPROPS

Used with CAPI_Store* functions to specify that the supplied properties are to be modified on the server without changing other properties (where possible).

Capabilities

The following capabilities can be requested via CAPI_GetCapabilities.

Typedefs

typedef long  CAPICapabilityID 

CAPI_CAPAB_ABOUT_BOX

Returns information about CAPI.

CAPI_CAPAB_AUTH

Returns the authentication mechanisms supported by the server (e.g. "cs-standard,gssapi:kerberos5,sasl:KERBEROS_V4"). A server connection must exist to read this capability.

CAPI_CAPAB_CAPI_VERSION

Returns the CAPI version as a string. (e.g. "2.5.0")

CAPI_CAPAB_COMP

Returns the compression mechanisms supported by the server (e.g. "cs-simple,none"). A server connection must exist to read this capability.

CAPI_CAPAB_ENCR

Returns the encryption mechanisms supported by the server (e.g. "cs-light,none"). A server connection must exist to read this capability.

CAPI_CAPAB_MAXDATE

Returns the largest date which CAPI can handle ("20371129").

CAPI_CAPAB_SERVER_VERSION

Returns the server version as a string. (e.g. "5.5"). A server connection must exist to read this capability.

CAPI_CAPAB_UNSUPPORTED_ICAL_COMP

Returns a comma delimited list of iCal components which CAPI does not process. ("VJOURNAL,VFREEBUSY")

CAPI_CAPAB_UNSUPPORTED_ICAL_PROP

Returns a comma delimited list of iCal properties which CAPI does not process. ("GEO,COMMENT"). A server connection must exist to read this capability.

CAPI_CAPAB_VERSION

Same as CAPI_CAPAB_CAPI_VERSION.