Prosody generic: API: sm_get_firmware_caps

This function is only in Prosody version 1 (see also the conversion guide for further details).

Prototype Definition

int sm_get_firmware_caps(struct sm_fwcaps_parms *fwcapsp)

Parameters

a structure of the following type:

typedef struct sm_fwcaps_parms {
	tSMModuleId module;					/* in */
	tSM_INT caps_length;					/* out */
	char caps[kSMMaxFWCapsLen];				/* out */
} SM_FWCAPS_PARMS;

Description

Interrogates a module and returns capability details for the firmware currently running. The data returned in caps may be parsed to determine specific firmware capabilities. The actual format of this information and details on how to parse it are described in the Aculab document Structure and Parsing of Prosody firmware capabilities data.

Fields

module (Only in Prosody version 1): The module on which information is required.
caps_length (Only in Prosody version 1): The length of the caps field.
caps (Only in Prosody version 1): The capability details.

Returns

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

ERR_SM_DEVERR - device error
ERR_SM_NO_SUCH_MODULE - if no such module exists.
ERR_SM_FIRMWARE_NOT_RUNNING - if no firmware running on module.

This function is part of the Prosody generic API.