:mod:`rattail.isv.cam32.conf`
=============================

.. automodule:: rattail.isv.cam32.conf

Functions for reading and modifying configuration of CAM32.

This module provides several convenience functions for reading various settings
from the ``CAM.INI`` file on the local machine.  Also, you may (at least try to)
read any setting you like from that file with the
:func:`cam32.config.get_ini_value()` function.

.. warning::

   A few of the functions involve (at least temporarily) *changing* some of CAM's
   configuration.  Please see the functions' documentation for more info, and
   please be careful!

.. note::

   Pretty much this entire module depends on being aware of the local CAM32
   installation path.  Since CAM32 itself doesn't record this path anywhere
   (that I've found), a small INI-type file must exist for this purpose.  This
   file must exist at ``<COMMON_APPDATA>\pycam32\pycam32.ini``; a real-world
   example of that location on my WinXP machine is::

      C:\Documents and Settings\All Users\Application Data\pycam32\pycam32.ini

   Also, since ``CAM32.EXE`` is only installed on server machines and not client
   machines, the ``pycam32.ini`` file should include a path to this executable
   as well.  Here is an entire ``pycam32.ini`` file as an example::

      [CAM32]
      store_number = 1
      install_path = C:\CAM32
      executable_path = C:\CAM32\CAM32.EXE

Functions
---------

.. autofunction:: rattail.isv.cam32.conf.get_avail_price_change_path

.. autofunction:: rattail.isv.cam32.conf.get_import_path

.. autofunction:: rattail.isv.cam32.conf.get_ini_path

.. autofunction:: rattail.isv.cam32.conf.get_ini_value

.. autofunction:: rattail.isv.cam32.conf.get_last_printed

.. autofunction:: rattail.isv.cam32.conf.get_print_path

.. autofunction:: rattail.isv.cam32.conf.get_public_path

.. autofunction:: rattail.isv.cam32.conf.get_scancode_file_path