Prosody generic: API: sm_close_module

Prototype Definition

int sm_close_module(struct sm_close_module_parms *closep)

Parameters

*closep

a structure of the following type:

typedef struct sm_close_module_parms {
	tSMModuleId module_id;					/* in */
} SM_CLOSE_MODULE_PARMS;

Description

Closes a Prosody module that was opened with sm_open_module(). Note that this function only releases any resources allocated by sm_open_module() and does not tidy up other resources connected with the module which may have been allocated by other API functions or the application. It is a serious error to close a module on which there are open channels.

Fields

module_id

The value obtained from sm_open_module() to be closed.

Returns

0 if call completed successfully, otherwise a standard error.

This function is part of the Prosody generic API.