PageRenderTime 65ms CodeModel.GetById 35ms RepoModel.GetById 0ms app.codeStats 0ms

/Source/modSpecialFolders.bas

#
Basic | 169 lines | 69 code | 9 blank | 91 comment | 0 complexity | 722450031b598f8a9e93f1b34e937b1f MD5 | raw file
Possible License(s): AGPL-1.0 
    

  1. Attribute VB_Name = "modSpecialFolders"

    2. 

  2. ' _____________________________________________________________________________

    3. 

  3. '|________________________________ SPECIAL FOLDER RETREAVAL ___________________|

    4. 

  4. '|  Name:          modSpecialFolders.bas                                       |

    5. 

  5. '|  Type:          VB6 Module                                                  |

    6. 

  6. '|  Project:       Cybera Server & Workstation (http://cybera.sf.net)          |

    7. 

  7. '|  Description:   Contains Windows special folder retreaval api calls & funcs.|

    8. 

  8. '|  Copyright:     (C) 2004-2006 Samuel Monsarrat (smonsarr@users.sf.net)      |

    9. 

  9. '|                                                                             |

    10. 

  10. '| This file is part of Cybera.                                                |

    11. 

  11. '|                                                                             |

    12. 

  12. '| Cybera is free software; you can redistribute it and/or modify it under the |

    13. 

  13. '| terms of the GNU General Public License as published by the Free Software   |

    14. 

  14. '| Foundation; either version 2 of the License, or (at your option) any later  |

    15. 

  15. '| version.                                                                    |

    16. 

  16. '|                                                                             |

    17. 

  17. '| Cybera is distributed in the hope that it will be useful, but WITHOUT ANY   |

    18. 

  18. '| WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS   |

    19. 

  19. '| FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more      |

    20. 

  20. '| details.                                                                    |

    21. 

  21. '|                                                                             |

    22. 

  22. '| You should have received a copy of the GNU General Public License along     |

    23. 

  23. '| with Cybera; if not, write to the Free Software Foundation, Inc.,           |

    24. 

  24. '| 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA                     |

    25. 

  25. '|                                                                             |

    26. 

  26. '|_____________________________________________________________________________|

    27. 

  27. 

    28. 

  28. ' $Id$

    29. 

  29. 

    30. 

  30. Option Explicit

    31. 

  31. 

    32. 

  32. ' Version 5.0. The file system directory that is used to store administrative tools for an individual user.

    33. 

  33. '   The Microsoft Management Console (MMC) will save customized consoles to this directory, and it will roam with the user.

    34. 

  34. Public Const CSIDL_ADMINTOOLS = &H30

    35. 

  35. ' The file system directory that corresponds to the user's nonlocalized Startup program group.

    36. 

  36. Public Const CSIDL_ALTSTARTUP = &H1D

    37. 

  37. ' Version 4.71. The file system directory that serves as a common repository for application-specific data.

    38. 

  38. '   A typical path is C:\Documents and Settings\username\Application Data. This CSIDL is supported by the redistributable

    39. 

  39. '   Shfolder.dll for systems that do not have the MicrosoftŽ Internet Explorer 4.0 integrated Shell installed.

    40. 

  40. Public Const CSIDL_APPDATA = &H1A

    41. 

  41. ' The virtual folder containing the objects in the user's Recycle Bin.

    42. 

  42. Public Const CSIDL_BITBUCKET = &HA

    43. 

  43. ' Version 6.0. The file system directory acting as a staging area for files waiting to be written to CD. A typical path

    44. 

  44. '   is C:\Documents and Settings\username\Local Settings\Application Data\Microsoft\CD Burning.

    45. 

  45. Public Const CSIDL_CDBURN_AREA = &H3B

    46. 

  46. '  Version 5.0. The file system directory containing administrative tools for all users of the computer.

    47. 

  47. Public Const CSIDL_COMMON_ADMINTOOLS = &H2F

    48. 

  48. ' The file system directory that corresponds to the nonlocalized Startup program group for all users. Valid only for Microsoft Windows NTŽ systems.

    49. 

  49. Public Const CSIDL_COMMON_ALTSTARTUP = &H1E

    50. 

  50. ' Version 5.0. The file system directory containing application data for all users. A typical path is C:\Documents and Settings\All Users\Application Data.

    51. 

  51. Public Const CSIDL_COMMON_APPDATA = &H23

    52. 

  52. ' The file system directory that contains files and folders that appear on the desktop for all users. A typical path is C:\Documents and Settings\All Users\Desktop.

    53. 

  53. '   Valid only for Windows NT systems.

    54. 

  54. Public Const CSIDL_COMMON_DESKTOPDIRECTORY = &H19

    55. 

  55. ' The file system directory that contains documents that are common to all users. A typical paths is C:\Documents and Settings\All Users\Documents.

    56. 

  56. '   Valid for Windows NT systems and Microsoft WindowsŽ 95 and Windows 98 systems with Shfolder.dll installed.

    57. 

  57. Public Const CSIDL_COMMON_DOCUMENTS = &H2E

    58. 

  58. ' The file system directory that serves as a common repository for favorite items common to all users. Valid only for Windows NT systems.

    59. 

  59. Public Const CSIDL_COMMON_FAVORITES = &H1F

    60. 

  60. ' Version 6.0. The file system directory that serves as a repository for music files common to all users. A typical path is C:\Documents and Settings\All Users\Documents\My Music.

    61. 

  61. Public Const CSIDL_COMMON_MUSIC = &H35

    62. 

  62. ' Version 6.0. The file system directory that serves as a repository for image files common to all users. A typical path is C:\Documents and Settings\All Users\Documents\My Pictures.

    63. 

  63. Public Const CSIDL_COMMON_PICTURES = &H36

    64. 

  64. ' The file system directory that contains the directories for the common program groups that appear on the Start menu for all users. A typical path is C:\Documents and Settings\All Users\Start Menu\Programs.

    65. 

  65. '   Valid only for Windows NT systems.

    66. 

  66. Public Const CSIDL_COMMON_PROGRAMS = &H17

    67. 

  67. ' The file system directory that contains the programs and folders that appear on the Start menu for all users. A typical path is C:\Documents and Settings\All Users\Start Menu. Valid only for Windows NT systems.

    68. 

  68. Public Const CSIDL_COMMON_STARTMENU = &H16

    69. 

  69. ' The file system directory that contains the programs that appear in the Startup folder for all users. A typical path is C:\Documents and Settings\All Users\Start Menu\Programs\Startup. Valid only for Windows NT systems.

    70. 

  70. Public Const CSIDL_COMMON_STARTUP = &H18

    71. 

  71. ' The file system directory that contains the templates that are available to all users. A typical path is C:\Documents and Settings\All Users\Templates. Valid only for Windows NT systems.

    72. 

  72. Public Const CSIDL_COMMON_TEMPLATES = &H2D

    73. 

  73. ' Version 6.0. The file system directory that serves as a repository for video files common to all users. A typical path is C:\Documents and Settings\All Users\Documents\My Videos.

    74. 

  74. Public Const CSIDL_COMMON_VIDEO = &H37

    75. 

  75. ' The virtual folder containing icons for the Control Panel applications.

    76. 

  76. Public Const CSIDL_CONTROLS = &H3

    77. 

  77. ' The file system directory that serves as a common repository for Internet cookies. A typical path is C:\Documents and Settings\username\Cookies.

    78. 

  78. Public Const CSIDL_COOKIES = &H21

    79. 

  79. ' The virtual folder representing the Windows desktop, the root of the namespace.

    80. 

  80. Public Const CSIDL_DESKTOP = &H0

    81. 

  81. ' The file system directory used to physically store file objects on the desktop (not to be confused with the desktop folder itself). A typical path is C:\Documents and Settings\username\Desktop.

    82. 

  82. Public Const CSIDL_DESKTOPDIRECTORY = &H10

    83. 

  83. ' The virtual folder representing My Computer, containing everything on the local computer: storage devices, printers, and Control Panel. The folder may also contain mapped network drives.

    84. 

  84. Public Const CSIDL_DRIVES = &H11

    85. 

  85. ' The file system directory that serves as a common repository for the user's favorite items. A typical path is C:\Documents and Settings\username\Favorites.

    86. 

  86. Public Const CSIDL_FAVORITES = &H6

    87. 

  87. ' A virtual folder containing fonts. A typical path is C:\Windows\Fonts.

    88. 

  88. Public Const CSIDL_FONTS = &H14

    89. 

  89. ' The file system directory that serves as a common repository for Internet history items.

    90. 

  90. Public Const CSIDL_HISTORY = &H22

    91. 

  91. ' A virtual folder representing the Internet.

    92. 

  92. Public Const CSIDL_INTERNET = &H1

    93. 

  93. ' Version 4.72. The file system directory that serves as a common repository for temporary Internet files. A typical path is C:\Documents and Settings\username\Local Settings\Temporary Internet Files.

    94. 

  94. Public Const CSIDL_INTERNET_CACHE = &H20

    95. 

  95. ' Version 5.0. The file system directory that serves as a data repository for local (nonroaming) applications. A typical path is C:\Documents and Settings\username\Local Settings\Application Data.

    96. 

  96. Public Const CSIDL_LOCAL_APPDATA = &H1C

    97. 

  97. ' Version 6.0. The virtual folder representing the My Documents desktop item. This should not be confused with CSIDL_PERSONAL, which represents the file system folder that physically stores the documents.

    98. 

  98. Public Const CSIDL_MYDOCUMENTS = &HC

    99. 

  99. ' The file system directory that serves as a common repository for music files. A typical path is C:\Documents and Settings\User\My Documents\My Music.

    100. 

  100. Public Const CSIDL_MYMUSIC = &HD

    101. 

  101. ' Version 5.0. The file system directory that serves as a common repository for image files. A typical path is C:\Documents and Settings\username\My Documents\My Pictures.

    102. 

  102. Public Const CSIDL_MYPICTURES = &H27

    103. 

  103. ' Version 6.0. The file system directory that serves as a common repository for video files. A typical path is C:\Documents and Settings\username\My Documents\My Videos.

    104. 

  104. Public Const CSIDL_MYVIDEO = &HE

    105. 

  105. ' A file system directory containing the link objects that may exist in the My Network Places virtual folder. It is not the same as CSIDL_NETWORK, which represents the network namespace root. A typical path is C:\Documents and Settings\username\NetHood.

    106. 

  106. Public Const CSIDL_NETHOOD = &H13

    107. 

  107. ' A virtual folder representing Network Neighborhood, the root of the network namespace hierarchy.

    108. 

  108. Public Const CSIDL_NETWORK = &H12

    109. 

  109. ' The file system directory used to physically store a user's common repository of documents. A typical path is C:\Documents and Settings\username\My Documents. This should be distinguished from the virtual My Documents folder in the namespace, identified by CSIDL_MYDOCUMENTS.

    110. 

  110. '   To access that virtual folder, use SHGetFolderLocation, which returns the ITEMIDLIST for the virtual location, or refer to the technique described in Managing the File System.

    111. 

  111. Public Const CSIDL_PERSONAL = &H5

    112. 

  112. ' The virtual folder containing installed printers.

    113. 

  113. Public Const CSIDL_PRINTERS = &H4

    114. 

  114. ' The file system directory that contains the link objects that can exist in the Printers virtual folder. A typical path is C:\Documents and Settings\username\PrintHood.

    115. 

  115. Public Const CSIDL_PRINTHOOD = &H1B

    116. 

  116. ' Version 5.0. The user's profile folder. A typical path is C:\Documents and Settings\username. Applications should not create files or folders at this level; they should put their data under the locations referred to by CSIDL_APPDATA or CSIDL_LOCAL_APPDATA.

    117. 

  117. Public Const CSIDL_PROFILE = &H28

    118. 

  118. ' Version 6.0. The file system directory containing user profile folders. A typical path is C:\Documents and Settings.

    119. 

  119. Public Const CSIDL_PROFILES = &H3E

    120. 

  120. ' Version 5.0. The Program Files folder. A typical path is C:\Program Files.

    121. 

  121. Public Const CSIDL_PROGRAM_FILES = &H26

    122. 

  122. ' Version 5.0. A folder for components that are shared across applications. A typical path is C:\Program Files\Common. Valid only for Windows NT, Windows 2000, and Windows XP systems. Not valid for Windows Millennium Edition (Windows Me).

    123. 

  123. Public Const CSIDL_PROGRAM_FILES_COMMON = &H2B

    124. 

  124. ' The file system directory that contains the user's program groups (which are themselves file system directories). A typical path is C:\Documents and Settings\username\Start Menu\Programs.

    125. 

  125. Public Const CSIDL_PROGRAMS = &H2

    126. 

  126. ' The file system directory that contains shortcuts to the user's most recently used documents. A typical path is C:\Documents and Settings\username\My Recent Documents. To create a shortcut in this folder, use SHAddToRecentDocs. In addition to creating the shortcut, this function updates the Shell's list of recent documents and adds the shortcut to the My Recent Documents submenu of the Start menu.

    127. 

  127. Public Const CSIDL_RECENT = &H8

    128. 

  128. ' The file system directory that contains Send To menu items. A typical path is C:\Documents and Settings\username\SendTo.

    129. 

  129. Public Const CSIDL_SENDTO = &H9

    130. 

  130. ' The file system directory containing Start menu items. A typical path is C:\Documents and Settings\username\Start Menu.

    131. 

  131. Public Const CSIDL_STARTMENU = &HB

    132. 

  132. ' The file system directory that corresponds to the user's Startup program group. The system starts these programs whenever any user logs onto Windows NT or starts Windows 95. A typical path is C:\Documents and Settings\username\Start Menu\Programs\Startup.

    133. 

  133. Public Const CSIDL_STARTUP = &H7

    134. 

  134. ' Version 5.0. The Windows System folder. A typical path is C:\Windows\System32.

    135. 

  135. Public Const CSIDL_SYSTEM = &H25

    136. 

  136. ' The file system directory that serves as a common repository for document templates. A typical path is C:\Documents and Settings\username\Templates.

    137. 

  137. Public Const CSIDL_TEMPLATES = &H15

    138. 

  138. ' Version 5.0. The Windows directory or SYSROOT. This corresponds to the %windir% or %SYSTEMROOT% environment variables. A typical path is C:\Windows.

    139. 

  139. Public Const CSIDL_WINDOWS = &H24

    140. 

  140. 

    141. 

  141. ' Defines an item identifier.

    142. 

  142. Public Type typSHITEMID

    143. 

  143.     cb As Long

    144. 

  144.     abID As Byte

    145. 

  145. End Type

    146. 

  146. 

    147. 

  147. ' Contains a list of item identifiers.

    148. 

  148. Public Type typITEMIDLIST

    149. 

  149.     mkid As typSHITEMID

    150. 

  150. End Type

    151. 

  151. 

    152. 

  152. ' The ShellExecute function opens or prints a specified file. The file can be an executable file or a document file.

    153. 

  153. 'Public Declare Function ShellExecute Lib "shell32.dll" Alias "ShellExecuteA" (ByVal hwnd As Long, ByVal lpOperation As String, ByVal lpFile As String, ByVal lpParameters As String, ByVal lpDirectory As String, ByVal nShowCmd As Long) As Long

    154. 

  154. ' Converts an item identifier list to a file system path.

    155. 

  155. Public Declare Function SHGetPathFromIDList Lib "shell32.dll" Alias "SHGetPathFromIDListA" (ByVal pidl As Long, ByVal pszPath As String) As Long

    156. 

  156. ' Retrieves a pointer to the ITEMIDLIST structure of a special folder.

    157. 

  157. Public Declare Function SHGetSpecialFolderLocation Lib "shell32.dll" (ByVal hwndOwner As Long, ByVal nFolder As Long, pidl As typITEMIDLIST) As Long

    158. 

  158. 

    159. 

  159. 

    160. 

  160. '*******************************************************************************

    161. 

  161. Public Function funGetFolderPath(CSIDL As Long) As String

    162. 

  162. Dim uIDL As typITEMIDLIST

    163. 

  163. Dim strtemp As String * 512

    164. 

  164. On Error Resume Next

    165. 

  165. 

    166. 

  166.     Call SHGetSpecialFolderLocation(0, CSIDL, uIDL)

    167. 

  167.     Call SHGetPathFromIDList(uIDL.mkid.cb, strtemp)

    168. 

  168.     funGetFolderPath = left$(strtemp, InStr(strtemp, Chr$(0)) - 1)

    169. 

  169. End Function

    170. 

  170.