Prosody PCI: API

The following functions are provided by the Prosody PCI API:

API call W Description
sm_open_prosody_pci() T Open a card for use with Prosody.

Key to W column:

T Only in Prosody version 2 (TiNG)

This document is also available as separate pages for each function.


Prosody PCI: API: sm_open_prosody_pci

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

Prototype Definition

int sm_open_prosody_pci(struct sm_open_prosody_pci_parms *openp)

Parameters

*openp
a structure of the following type:
typedef struct sm_open_prosody_pci_parms {
	char serial_no[kSMMaxSerialNoPCI];			/* in */
	tSMCardId card_id;					/* in */
} SM_OPEN_PROSODY_PCI_PARMS;

Description

Opens a card for use with Prosody. 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.

Fields

serial_no (Only in Prosody version 2 (TiNG))
The serial number of this card.
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.


These functions constitute the Prosody PCI API.