SPD_InitClient

Purpose

Initialize the Event Server API. A client application must call this function before calling any other SPD function.

Syntax

#include "spd.h"
 
SPD_errorTP SPD_InitClient(
   char *applicationName,
   char *applicationQualifier
);

Description

applicationName

is the name that identifies the client application to the Event Server. This is the name that will be associated with events generated by the client.

applicationQualifier

further qualifies the client application in the case where more than one instance of the client may be present. This is an optional parameter. Specify NULL if the client is not further qualified.

Library Levels

In some situations, installing a newer level of Operations Sentinel may cause incompatibilities in Event Server API library levels. Client applications that are linked with older levels of the Event Server API library may no longer function properly. The client application is informed about incompatibility in software levels in one of the following ways:

If the Event Server is active when the client calls the function SPD_InitClient
- The function returns the status SPD_versionMismatchCN
- Any calls to other API functions return an error status
If the Event Server is not active when the client calls the function SPD_InitClient and an incompatible version of the Event Server later becomes active
- The function returns the status SPD_normalCN
- The client is terminated when it connects to the Event Server
- An error message is sent to standard output (stdout)

In either of these cases, you must recompile and relink the client application with the new Event Server API library and header files.

Return Value

The return value indicates whether an error occurred, as follows:

Return	Indication
SPD_normalCN	No error.
SPD_alreadyInitializedCN	SPD_InitClient has already been called.
SPD_badApplicationCN	Bad value for applicationName parameter.
SPD_versionMismatchCN	The client application is linked with a version of the Event Server API library that is incompatible with the Event Server of the currently installed level of Operations Sentinel.
SPD_commFailureCN	Communications problem.