Prosody S: API: sm_open_prosody_s

This function is only in Prosody version 2 (TiNG).

Prototype Definition

int sm_open_prosody_s(struct sm_open_prosody_s_parms *openp)

Parameters

*openp

a structure of the following type:

typedef struct sm_open_prosody_s_parms {
	char *portname;						/* in */
	tSMCardId card_id;					/* in */
} SM_OPEN_PROSODY_S_PARMS;

Description

Opens a Prosody S server for use with the Prosody API. This function must be invoked by applications using the V6 interface to register the tSMCardId value for passing into any other Prosody API function which refers to this card.

For version 3 or higher servers this function should not be used. The replacement is sm_open_prosody_s_v3()

Fields

portname (Only in Prosody version 2 (TiNG))

The port used by the Prosody S server

card_id (Only in Prosody version 2 (TiNG))

An arbitrary value representing the open card.

Returns

0 if call completed successfully, otherwise a standard error.

This function is part of the Prosody S API.