aqt.winpaths
============

.. py:module:: aqt.winpaths

.. autoapi-nested-parse::

   System File Locations
   Retrieves common system path names on Windows XP/Vista
   Depends only on ctypes, and retrieves path locations in Unicode



Attributes
----------

.. autoapisummary::

   aqt.winpaths.get_my_documents


Exceptions
----------

.. autoapisummary::

   aqt.winpaths.WinPathsException


Classes
-------

.. autoapisummary::

   aqt.winpaths.PathConstants


Functions
---------

.. autoapisummary::

   aqt.winpaths.get_local_appdata
   aqt.winpaths.get_appdata
   aqt.winpaths.get_desktop
   aqt.winpaths.get_programs
   aqt.winpaths.get_admin_tools
   aqt.winpaths.get_common_admin_tools
   aqt.winpaths.get_common_appdata
   aqt.winpaths.get_common_documents
   aqt.winpaths.get_cookies
   aqt.winpaths.get_history
   aqt.winpaths.get_internet_cache
   aqt.winpaths.get_my_pictures
   aqt.winpaths.get_personal
   aqt.winpaths.get_program_files
   aqt.winpaths.get_program_files_common
   aqt.winpaths.get_system
   aqt.winpaths.get_windows
   aqt.winpaths.get_favorites
   aqt.winpaths.get_startup
   aqt.winpaths.get_recent


Module Contents
---------------

.. py:class:: PathConstants

   Define constants here to avoid dependency on shellcon.
   Put it in a class to avoid polluting namespace


   .. py:attribute:: CSIDL_DESKTOP
      :value: 0



   .. py:attribute:: CSIDL_PROGRAMS
      :value: 2



   .. py:attribute:: CSIDL_PERSONAL
      :value: 5



   .. py:attribute:: CSIDL_FAVORITES
      :value: 6



   .. py:attribute:: CSIDL_STARTUP
      :value: 7



   .. py:attribute:: CSIDL_RECENT
      :value: 8



   .. py:attribute:: CSIDL_SENDTO
      :value: 9



   .. py:attribute:: CSIDL_BITBUCKET
      :value: 10



   .. py:attribute:: CSIDL_STARTMENU
      :value: 11



   .. py:attribute:: CSIDL_MYDOCUMENTS
      :value: 12



   .. py:attribute:: CSIDL_MYMUSIC
      :value: 13



   .. py:attribute:: CSIDL_MYVIDEO
      :value: 14



   .. py:attribute:: CSIDL_DESKTOPDIRECTORY
      :value: 16



   .. py:attribute:: CSIDL_DRIVES
      :value: 17



   .. py:attribute:: CSIDL_NETWORK
      :value: 18



   .. py:attribute:: CSIDL_NETHOOD
      :value: 19



   .. py:attribute:: CSIDL_FONTS
      :value: 20



   .. py:attribute:: CSIDL_TEMPLATES
      :value: 21



   .. py:attribute:: CSIDL_COMMON_STARTMENU
      :value: 22



   .. py:attribute:: CSIDL_COMMON_PROGRAMS
      :value: 23



   .. py:attribute:: CSIDL_COMMON_STARTUP
      :value: 24



   .. py:attribute:: CSIDL_COMMON_DESKTOPDIRECTORY
      :value: 25



   .. py:attribute:: CSIDL_APPDATA
      :value: 26



   .. py:attribute:: CSIDL_PRINTHOOD
      :value: 27



   .. py:attribute:: CSIDL_LOCAL_APPDATA
      :value: 28



   .. py:attribute:: CSIDL_ALTSTARTUP
      :value: 29



   .. py:attribute:: CSIDL_COMMON_ALTSTARTUP
      :value: 30



   .. py:attribute:: CSIDL_COMMON_FAVORITES
      :value: 31



   .. py:attribute:: CSIDL_INTERNET_CACHE
      :value: 32



   .. py:attribute:: CSIDL_COOKIES
      :value: 33



   .. py:attribute:: CSIDL_HISTORY
      :value: 34



   .. py:attribute:: CSIDL_COMMON_APPDATA
      :value: 35



   .. py:attribute:: CSIDL_WINDOWS
      :value: 36



   .. py:attribute:: CSIDL_SYSTEM
      :value: 37



   .. py:attribute:: CSIDL_PROGRAM_FILES
      :value: 38



   .. py:attribute:: CSIDL_MYPICTURES
      :value: 39



   .. py:attribute:: CSIDL_PROFILE
      :value: 40



   .. py:attribute:: CSIDL_SYSTEMX86
      :value: 41



   .. py:attribute:: CSIDL_PROGRAM_FILESX86
      :value: 42



   .. py:attribute:: CSIDL_PROGRAM_FILES_COMMON
      :value: 43



   .. py:attribute:: CSIDL_PROGRAM_FILES_COMMONX86
      :value: 44



   .. py:attribute:: CSIDL_COMMON_TEMPLATES
      :value: 45



   .. py:attribute:: CSIDL_COMMON_DOCUMENTS
      :value: 46



   .. py:attribute:: CSIDL_COMMON_ADMINTOOLS
      :value: 47



   .. py:attribute:: CSIDL_ADMINTOOLS
      :value: 48



   .. py:attribute:: CSIDL_CONNECTIONS
      :value: 49



   .. py:attribute:: CSIDL_COMMON_MUSIC
      :value: 53



   .. py:attribute:: CSIDL_COMMON_PICTURES
      :value: 54



   .. py:attribute:: CSIDL_COMMON_VIDEO
      :value: 55



   .. py:attribute:: CSIDL_RESOURCES
      :value: 56



   .. py:attribute:: CSIDL_RESOURCES_LOCALIZED
      :value: 57



   .. py:attribute:: CSIDL_COMMON_OEM_LINKS
      :value: 58



   .. py:attribute:: CSIDL_CDBURN_AREA
      :value: 59



   .. py:attribute:: CSIDL_COMPUTERSNEARME
      :value: 61



.. py:exception:: WinPathsException

   Bases: :py:obj:`Exception`


   Common base class for all non-exit exceptions.


.. py:function:: get_local_appdata()

.. py:function:: get_appdata()

.. py:function:: get_desktop()

.. py:function:: get_programs()

   current user -> Start menu -> Programs


.. py:function:: get_admin_tools()

   current user -> Start menu -> Programs -> Admin tools


.. py:function:: get_common_admin_tools()

   all users -> Start menu -> Programs -> Admin tools


.. py:function:: get_common_appdata()

.. py:function:: get_common_documents()

.. py:function:: get_cookies()

.. py:function:: get_history()

.. py:function:: get_internet_cache()

.. py:function:: get_my_pictures()

   Get the user's My Pictures folder


.. py:function:: get_personal()

   AKA 'My Documents'


.. py:data:: get_my_documents

.. py:function:: get_program_files()

.. py:function:: get_program_files_common()

.. py:function:: get_system()

   Use with care and discretion


.. py:function:: get_windows()

   Use with care and discretion


.. py:function:: get_favorites()

.. py:function:: get_startup()

   current user -> start menu -> programs -> startup


.. py:function:: get_recent()