Sun Java System Calendar Server 6 2005Q4 Developer's Guide

API: csICalendarServer

Provides server version information to a plug-in module.

Methods

The csICalendarServer interface implements two methods:

Method: GetVersion

Get the calendar server version. 

Method: Init

Confirms that the interface was found and registered. 

Description

Plug-in modules can query the csICalendarServer interface to get version information about the running instance of Calendar Server. The object is valid for the full lifetime of the client, so Init does not return a reference.

Method: GetVersion

Purpose

Provide plug-in module with server version information.

Syntax

PRUint32 GetVersion (PRUint32& aMajorValue, PRUint32& aMinorValue)=0;

Parameters

The method has the following two parameters:

aMajorValue

On return, contains the major version number. 

aMinorValue

On return, contains the minor version number. 

Returns

NS_OK on success, non-zero error code on failure.

Description

Use this method to identify the server’s major and minor version number. The number is always greater than or equal to 1.0.

Method: Init

Purpose

Confirm that the interface has been registered.

Syntax

PRUint32 Init()=0;

Parameters

The method has no parameters.

Returns

NS_OK on success, non-zero error code on failure.

Description

The server calls this method to confirm that the interface was found and registered successfully.