Unix/Linux Go Back    


CentOS 7.0 - man page for file::homedir::windows (centos section 3)

Linux & Unix Commands - Search Man Pages
Man Page or Keyword Search:   man
Select Man Page Set:       apropos Keyword Search (sections above)


File::HomeDir::Windows(3)      User Contributed Perl Documentation	File::HomeDir::Windows(3)

NAME
       File::HomeDir::Windows - Find your home and other directories on Windows

SYNOPSIS
	 use File::HomeDir;

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

DESCRIPTION
       This module provides Windows-specific implementations for determining common user
       directories.  In normal usage this module will always be used via File::HomeDir.

       Internally this module will use Win32::GetFolderPath to fetch the location of your
       directories. As a result of this, in certain unusual situations (usually found inside
       large organisations) the methods may return UNC paths such as "\\cifs.local\home$".

       If your application runs on Windows and you want to have it work comprehensively
       everywhere, you may need to implement your own handling for these paths as they can cause
       strange behaviour.

       For example, stat calls to UNC paths may work but block for several seconds, but opendir()
       may not be able to read any files (creating the appearance of an existing but empty
       directory).

       To avoid complicating the problem any further, in the rare situation that a UNC path is
       returned by "GetFolderPath" the usual -d validation checks will not be done.

SUPPORT
       See the support section the main File::HomeDir module.

AUTHORS
       Adam Kennedy <adamk@cpan.org>

       Sean M. Burke <sburke@cpan.org>

SEE ALSO
       File::HomeDir, File::HomeDir::Win32 (legacy)

COPYRIGHT
       Copyright 2005 - 2011 Adam Kennedy.

       Some parts copyright 2000 Sean M. Burke.

       This program is free software; you can redistribute it and/or modify it under the same
       terms as Perl itself.

       The full text of the license can be found in the LICENSE file included with this module.

perl v5.16.3				    2012-10-19			File::HomeDir::Windows(3)
Unix & Linux Commands & Man Pages : ©2000 - 2018 Unix and Linux Forums


All times are GMT -4. The time now is 10:36 PM.