1File::HomeDir::Windows(U3s)er Contributed Perl DocumentatFiiolne::HomeDir::Windows(3)
2
3
4

NAME

6       File::HomeDir::Windows - Find your home and other directories on
7       Windows
8

SYNOPSIS

10         use File::HomeDir;
11
12         # Find directories for the current user (eg. using Windows XP Professional)
13         $home    = File::HomeDir->my_home;        # C:\Documents and Settings\mylogin
14         $desktop = File::HomeDir->my_desktop;     # C:\Documents and Settings\mylogin\Desktop
15         $docs    = File::HomeDir->my_documents;   # C:\Documents and Settings\mylogin\My Documents
16         $music   = File::HomeDir->my_music;       # C:\Documents and Settings\mylogin\My Documents\My Music
17         $pics    = File::HomeDir->my_pictures;    # C:\Documents and Settings\mylogin\My Documents\My Pictures
18         $videos  = File::HomeDir->my_videos;      # C:\Documents and Settings\mylogin\My Documents\My Video
19         $data    = File::HomeDir->my_data;        # C:\Documents and Settings\mylogin\Local Settings\Application Data
20

DESCRIPTION

22       This module provides Windows-specific implementations for determining
23       common user directories.  In normal usage this module will always be
24       used via File::HomeDir.
25
26       Internally this module will use Win32::GetFolderPath to fetch the
27       location of your directories. As a result of this, in certain unusual
28       situations (usually found inside large organizations) the methods may
29       return UNC paths such as "\\cifs.local\home$".
30
31       If your application runs on Windows and you want to have it work
32       comprehensively everywhere, you may need to implement your own handling
33       for these paths as they can cause strange behaviour.
34
35       For example, stat calls to UNC paths may work but block for several
36       seconds, but opendir() may not be able to read any files (creating the
37       appearance of an existing but empty directory).
38
39       To avoid complicating the problem any further, in the rare situation
40       that a UNC path is returned by "GetFolderPath" the usual -d validation
41       checks will not be done.
42

SUPPORT

44       See the support section the main File::HomeDir module.
45

AUTHORS

47       Adam Kennedy <adamk@cpan.org>
48
49       Sean M. Burke <sburke@cpan.org>
50

SEE ALSO

52       File::HomeDir, File::HomeDir::Win32 (legacy)
53

55       Copyright 2005 - 2011 Adam Kennedy.
56
57       Copyright 2017 - 2020 Jens Rehsack
58
59       Some parts copyright 2000 Sean M. Burke.
60
61       This program is free software; you can redistribute it and/or modify it
62       under the same terms as Perl itself.
63
64       The full text of the license can be found in the LICENSE file included
65       with this module.
66
67
68
69perl v5.36.0                      2023-01-20         File::HomeDir::Windows(3)
Impressum