Header File Index

| Entry Points

### ticalcs_library_init

TIEXPORT3 int TICALL ticalcs_library_init(void)

This function must be the first one to call. It inits library internals.

Return value : | the instance count.

### ticalcs_library_exit

TIEXPORT3 int TICALL ticalcs_library_exit(void)

This function must be the last one to call. Used to release internal resources.

Return value : | the instance count.

### ticalcs_version_get

TIEXPORT3 const char *TICALL ticalcs_version_get(void)

This function returns the library version like "X.Y.Z".

Return value : | a string.

### ticalcs_supported_calcs

TIEXPORT3 uint32_t TICALL ticalcs_supported_calcs (void)

This function returns the calcs built into the current binary.

Return value : | an integer containing a binary OR of (1 << CALC_*) values, where CALC_* values are defined in enum CalcModel.

### ticalcs_handle_new

TIEXPORT3 CalcHandle* TICALL ticalcs_handle_new(CalcModel model)

Create a new handle associated with the given cable on the given port. Must be freed with ticables_handle_del when no longer needed. Note: the handle is a pointer on an opaque structure and should not be modified.

model : | a hand-held model
Return value : | NULL if error, an handle otherwise.

### ticalcs_handle_del

TIEXPORT3 int TICALL ticalcs_handle_del(CalcHandle* handle)

Release the cable and free the associated resources. If cable has not been detached with #ticalcs_cable_detach, it will be detached.

handle : | the handle
Return value : | always 0.

### ticalcs_handle_show

TIEXPORT3 int TICALL ticalcs_handle_show(CalcHandle* handle)

Show information stored in the handle.

handle : | the handle
Return value : | always 0.

### ticalcs_cable_attach

TIEXPORT3 int TICALL ticalcs_cable_attach(CalcHandle* handle, CableHandle* cable)

Attach and open the given cable for use with the hand-held.

handle : | the handle
cable : | a cable to use
Return value : | 0 if successful, an error code otherwise.

### ticalcs_cable_detach

TIEXPORT3 int TICALL ticalcs_cable_detach(CalcHandle* handle)

Close and detach the cable associated with the hand-held.

handle : | the handle
cable : | a cable to use
Return value : | 0 if successful, an error code otherwise.

### ticalcs_update_set

TIEXPORT3 int TICALL ticalcs_update_set(CalcHandle* handle, CalcUpdate* upd)

Set the callbacks to use for the given handle.

handle : | the handle
update : | the callbacks to use
Return value : | 0 if successful, an error code otherwise.

### ticalcs_model_supports_dbus

{

Returns whether the given calculator model supports the protocol dubbed DBUS by libticalcs. That is, the standard protocol used by TI-Z80 and TI-68k calculators over the legacy I/O.

model : | a calculator model taken in #CalcModel.
Return value : | nonzero if the calculator supports the DBUS protocol, zero if it doesn't.

### ticalcs_model_supports_dusb

{

Returns whether the given calculator model supports the protocol dubbed DUSB by libticalcs. That is, the standard protocol used by TI-Z80, TI-eZ80 and TI-68k calculators over the USB port.

model : | a calculator model taken in #CalcModel.
Return value : | nonzero if the calculator supports the DUSB protocol, zero if it doesn't.

### ticalcs_model_supports_nsp

{

Returns whether the given calculator model supports the protocol dubbed NSP by libticalcs. That is, the standard protocol used by TI-Nspire calculators over the USB port.

model : | a calculator model taken in #CalcModel.
Return value : | nonzero if the calculator supports the NSP protocol, zero if it doesn't.

### Return to the main index