Show / Hide Table of Contents

Method folders.getFolder


Overload

Gets path of a known folder by its name.

public static FolderPath getFolder(string folderName)
Parameters
folderName  (string)

Can be:

  • name of a property of this class, like "Documents", "Temp", "ThisApp". The property must return FolderPath or string.
  • name of a property of the nested class folders.shell, like "shell.ControlPanel". Gets ":: ITEMIDLIST".
  • known folder canonical name. See folders.getKnownFolders. If has prefix "shell.", gets ":: ITEMIDLIST". Much slower, but allows to get paths of folders registered by applications.
Returns
FolderPath

null if unavailable.

See Also

pathname.expand