Prosody generic: API: sm_open_module

Prototype Definition

int sm_open_module(struct sm_open_module_parms *module_parmsp)

Parameters

*module_parmsp

a structure of the following type:

typedef struct sm_open_module_parms {
	tSMCardId card_id;					/* in */
	tSM_UT32 module_ix;					/* in */
	tSMModuleId module_id;					/* out */
} SM_OPEN_MODULE_PARMS;

Description

Opens a specified Prosody module.

Fields

card_id

The card, which has been opened (e.g. with sm_open_prosody_x() ) and on which is the module to be opened,

module_ix

The physical module number of the module to open. This is the zero-based index of the module on the card specified by card_id. The module numbers refer to positions on the card, so a card which has connectors for plugging in a module will always use the same number for a module plugged into a particular position regardless of which other positions are occupied.

module_id

The opened module.

Returns

0 if call completed successfully, otherwise a standard error such as:

• ERR_SM_NO_SUCH_MODULE - if no such module exists

This function is part of the Prosody generic API.