DLLGetSpecialFolder()

DLLGetSpecialFolder()
  • SYNOPSIS:
    folderpath$ = DLLGetSpecialFolder$(iFlags,[iOutBufferSize])
  • DESCRIPTION:
    This command is an extension of the original internal Blitz command: SystemProperty()
    It gets one of the user's special directory paths (see iFlags).
  • PARAMETERS:
    iFlags

    Any of the following flags are valid:

    CSIDL_BITBUCKET - Recycle bin ¾ file system directory containing file objects in the user’s recycle bin. The location of this directory is not in the registry; it is marked with the hidden and system attributes to prevent the user from moving or deleting it.
    CSIDL_CONTROLS - Control Panel ¾ virtual folder containing icons for the control panel applications.
    CSIDL_DESKTOP - Windows desktop ¾ virtual folder at the root of the name space.
    CSIDL_DESKTOPDIRECTORY - File system directory used to physically store file objects on the desktop (not to be confused with the desktop folder itself).
    CSIDL_DRIVES - My Computer ¾ virtual folder containing everything on the local computer: storage devices, printers, and Control Panel. The folder may also contain mapped network drives.
    CSIDL_FONTS - Virtual folder containing fonts.
    CSIDL_NETHOOD - File system directory containing objects that appear in the network neighborhood.
    CSIDL_NETWORK - Network Neighborhood ¾ virtual folder representing the top level of the network hierarchy.
    CSIDL_PERSONAL - File system directory that serves as a common respository for documents.
    CSIDL_PRINTERS - Printers folder ¾ virtual folder containing installed printers.
    CSIDL_PROGRAMS - File system directory that contains the user’s program groups (which are also file system directories).
    CSIDL_RECENT - File system directory that contains the user’s most recently used documents.
    CSIDL_SENDTO - File system directory that contains Send To menu items.
    CSIDL_STARTMENU - File system directory containing Start menu items.
    CSIDL_STARTUP - File system directory that corresponds to the user’s Startup program group.
    CSIDL_TEMPLATES - File system directory that serves as a common repository for document templates.
    CSIDL_INTERNET
    CSIDL_FAVORITES
    CSIDL_COMMON_STARTMENU
    CSIDL_COMMON_PROGRAMS
    CSIDL_COMMON_STARTUP
    CSIDL_COMMON_DESKTOPDIRECTORY
    CSIDL_PRINTHOOD
    CSIDL_LOCAL_APPDATA
    CSIDL_ALTSTARTUP
    CSIDL_COMMON_ALTSTARTUP
    CSIDL_COMMON_FAVORITES
    CSIDL_INTERNET_CACHE
    CSIDL_COOKIES
    CSIDL_HISTORY
    CSIDL_COMMON_APPDATA
    CSIDL_WINDOWS
    CSIDL_SYSTEM
    CSIDL_PROGRAM_FILES
    CSIDL_MYPICTURES
    CSIDL_PROFILE
    CSIDL_SYSTEMX86
    CSIDL_PROGRAM_FILESX86
    CSIDL_PROGRAM_FILES_COMMON
    CSIDL_PROGRAM_FILES_COMMONX86
    CSIDL_COMMON_TEMPLATES
    CSIDL_COMMON_DOCUMENTS
    CSIDL_COMMON_ADMINTOOLS
    CSIDL_ADMINTOOLS
    CSIDL_CONNECTIONS
    CSIDL_FLAG_CREATE
    CSIDL_FLAG_DONT_VERIFY
    CSIDL_FLAG_MASK

    iOutBufferSize (optional) The size of the buffer that the special directory name will be returned in. Defaults to 512.
  • RETURNS:
    A string containing the special directory name, or "" if failed/no dir.
  • EXAMPLE:
    See example007.bb
  • BUGS:
    None Known.

Return To Index
Problems with this command or bugs? EMail me at: mailto:loki.sd@blueyonder.co.uk

Section Last Updated: Saturday, February 2, 2002 2:11 PM GMT

All materials used in this help, related sources and binaries are (C)opyright Rob Hutchinson, Joseph Cox and Tarropithium Software 2002. All rights reserved. All software is provided without warranty unless otherwise stated.
Tarropithium Software or the authors will not be held liable for any damage or data loss that may occur during the application of this software. Use it at your own risk!