[perl5.git] / cpan / Win32 / Win32.pm

package Win32;\r
\r
BEGIN {\r
    use strict;\r
    use vars qw|$VERSION $XS_VERSION @ISA @EXPORT @EXPORT_OK|;\r
\r
    require Exporter;\r
    require DynaLoader;\r
\r
    @ISA = qw|Exporter DynaLoader|;\r
    $VERSION = '0.39';\r
    $XS_VERSION = $VERSION;\r
    $VERSION = eval $VERSION;\r
\r
    @EXPORT = qw(\r
	NULL\r
	WIN31_CLASS\r
	OWNER_SECURITY_INFORMATION\r
	GROUP_SECURITY_INFORMATION\r
	DACL_SECURITY_INFORMATION\r
	SACL_SECURITY_INFORMATION\r
	MB_ICONHAND\r
	MB_ICONQUESTION\r
	MB_ICONEXCLAMATION\r
	MB_ICONASTERISK\r
	MB_ICONWARNING\r
	MB_ICONERROR\r
	MB_ICONINFORMATION\r
	MB_ICONSTOP\r
    );\r
    @EXPORT_OK = qw(\r
        GetOSName\r
        SW_HIDE\r
        SW_SHOWNORMAL\r
        SW_SHOWMINIMIZED\r
        SW_SHOWMAXIMIZED\r
        SW_SHOWNOACTIVATE\r
\r
        CSIDL_DESKTOP\r
        CSIDL_PROGRAMS\r
        CSIDL_PERSONAL\r
        CSIDL_FAVORITES\r
        CSIDL_STARTUP\r
        CSIDL_RECENT\r
        CSIDL_SENDTO\r
        CSIDL_STARTMENU\r
        CSIDL_MYMUSIC\r
        CSIDL_MYVIDEO\r
        CSIDL_DESKTOPDIRECTORY\r
        CSIDL_NETHOOD\r
        CSIDL_FONTS\r
        CSIDL_TEMPLATES\r
        CSIDL_COMMON_STARTMENU\r
        CSIDL_COMMON_PROGRAMS\r
        CSIDL_COMMON_STARTUP\r
        CSIDL_COMMON_DESKTOPDIRECTORY\r
        CSIDL_APPDATA\r
        CSIDL_PRINTHOOD\r
        CSIDL_LOCAL_APPDATA\r
        CSIDL_COMMON_FAVORITES\r
        CSIDL_INTERNET_CACHE\r
        CSIDL_COOKIES\r
        CSIDL_HISTORY\r
        CSIDL_COMMON_APPDATA\r
        CSIDL_WINDOWS\r
        CSIDL_SYSTEM\r
        CSIDL_PROGRAM_FILES\r
        CSIDL_MYPICTURES\r
        CSIDL_PROFILE\r
        CSIDL_PROGRAM_FILES_COMMON\r
        CSIDL_COMMON_TEMPLATES\r
        CSIDL_COMMON_DOCUMENTS\r
        CSIDL_COMMON_ADMINTOOLS\r
        CSIDL_ADMINTOOLS\r
        CSIDL_COMMON_MUSIC\r
        CSIDL_COMMON_PICTURES\r
        CSIDL_COMMON_VIDEO\r
        CSIDL_RESOURCES\r
        CSIDL_RESOURCES_LOCALIZED\r
        CSIDL_CDBURN_AREA\r
    );\r
}\r
\r
# We won't bother with the constant stuff, too much of a hassle.  Just hard\r
# code it here.\r
\r
sub NULL 				{ 0 }\r
sub WIN31_CLASS 			{ &NULL }\r
\r
sub OWNER_SECURITY_INFORMATION		{ 0x00000001 }\r
sub GROUP_SECURITY_INFORMATION		{ 0x00000002 }\r
sub DACL_SECURITY_INFORMATION		{ 0x00000004 }\r
sub SACL_SECURITY_INFORMATION		{ 0x00000008 }\r
\r
sub MB_ICONHAND				{ 0x00000010 }\r
sub MB_ICONQUESTION			{ 0x00000020 }\r
sub MB_ICONEXCLAMATION			{ 0x00000030 }\r
sub MB_ICONASTERISK			{ 0x00000040 }\r
sub MB_ICONWARNING			{ 0x00000030 }\r
sub MB_ICONERROR			{ 0x00000010 }\r
sub MB_ICONINFORMATION			{ 0x00000040 }\r
sub MB_ICONSTOP				{ 0x00000010 }\r
\r
#\r
# Newly added constants.  These have an empty prototype, unlike the\r
# the ones above, which aren't prototyped for compatibility reasons.\r
#\r
sub SW_HIDE           ()		{ 0 }\r
sub SW_SHOWNORMAL     ()		{ 1 }\r
sub SW_SHOWMINIMIZED  ()		{ 2 }\r
sub SW_SHOWMAXIMIZED  ()		{ 3 }\r
sub SW_SHOWNOACTIVATE ()		{ 4 }\r
\r
sub CSIDL_DESKTOP              ()       { 0x0000 }     # <desktop>\r
sub CSIDL_PROGRAMS             ()       { 0x0002 }     # Start Menu\Programs\r
sub CSIDL_PERSONAL             ()       { 0x0005 }     # "My Documents" folder\r
sub CSIDL_FAVORITES            ()       { 0x0006 }     # <user name>\Favorites\r
sub CSIDL_STARTUP              ()       { 0x0007 }     # Start Menu\Programs\Startup\r
sub CSIDL_RECENT               ()       { 0x0008 }     # <user name>\Recent\r
sub CSIDL_SENDTO               ()       { 0x0009 }     # <user name>\SendTo\r
sub CSIDL_STARTMENU            ()       { 0x000B }     # <user name>\Start Menu\r
sub CSIDL_MYMUSIC              ()       { 0x000D }     # "My Music" folder\r
sub CSIDL_MYVIDEO              ()       { 0x000E }     # "My Videos" folder\r
sub CSIDL_DESKTOPDIRECTORY     ()       { 0x0010 }     # <user name>\Desktop\r
sub CSIDL_NETHOOD              ()       { 0x0013 }     # <user name>\nethood\r
sub CSIDL_FONTS                ()       { 0x0014 }     # windows\fonts\r
sub CSIDL_TEMPLATES            ()       { 0x0015 }\r
sub CSIDL_COMMON_STARTMENU     ()       { 0x0016 }     # All Users\Start Menu\r
sub CSIDL_COMMON_PROGRAMS      ()       { 0x0017 }     # All Users\Start Menu\Programs\r
sub CSIDL_COMMON_STARTUP       ()       { 0x0018 }     # All Users\Startup\r
sub CSIDL_COMMON_DESKTOPDIRECTORY ()    { 0x0019 }     # All Users\Desktop\r
sub CSIDL_APPDATA              ()       { 0x001A }     # Application Data, new for NT4\r
sub CSIDL_PRINTHOOD            ()       { 0x001B }     # <user name>\PrintHood\r
sub CSIDL_LOCAL_APPDATA        ()       { 0x001C }     # non roaming, user\Local Settings\Application Data\r
sub CSIDL_COMMON_FAVORITES     ()       { 0x001F }\r
sub CSIDL_INTERNET_CACHE       ()       { 0x0020 }\r
sub CSIDL_COOKIES              ()       { 0x0021 }\r
sub CSIDL_HISTORY              ()       { 0x0022 }\r
sub CSIDL_COMMON_APPDATA       ()       { 0x0023 }     # All Users\Application Data\r
sub CSIDL_WINDOWS              ()       { 0x0024 }     # GetWindowsDirectory()\r
sub CSIDL_SYSTEM               ()       { 0x0025 }     # GetSystemDirectory()\r
sub CSIDL_PROGRAM_FILES        ()       { 0x0026 }     # C:\Program Files\r
sub CSIDL_MYPICTURES           ()       { 0x0027 }     # "My Pictures", new for Win2K\r
sub CSIDL_PROFILE              ()       { 0x0028 }     # USERPROFILE\r
sub CSIDL_PROGRAM_FILES_COMMON ()       { 0x002B }     # C:\Program Files\Common\r
sub CSIDL_COMMON_TEMPLATES     ()       { 0x002D }     # All Users\Templates\r
sub CSIDL_COMMON_DOCUMENTS     ()       { 0x002E }     # All Users\Documents\r
sub CSIDL_COMMON_ADMINTOOLS    ()       { 0x002F }     # All Users\Start Menu\Programs\Administrative Tools\r
sub CSIDL_ADMINTOOLS           ()       { 0x0030 }     # <user name>\Start Menu\Programs\Administrative Tools\r
sub CSIDL_COMMON_MUSIC         ()       { 0x0035 }     # All Users\My Music\r
sub CSIDL_COMMON_PICTURES      ()       { 0x0036 }     # All Users\My Pictures\r
sub CSIDL_COMMON_VIDEO         ()       { 0x0037 }     # All Users\My Video\r
sub CSIDL_RESOURCES            ()       { 0x0038 }     # %windir%\Resources\, For theme and other windows resources.\r
sub CSIDL_RESOURCES_LOCALIZED  ()       { 0x0039 }     # %windir%\Resources\<LangID>, for theme and other windows specific resources.\r
sub CSIDL_CDBURN_AREA          ()       { 0x003B }     # <user name>\Local Settings\Application Data\Microsoft\CD Burning\r
\r
### This method is just a simple interface into GetOSVersion().  More\r
### specific or demanding situations should use that instead.\r
\r
my ($cached_os, $cached_desc);\r
\r
sub GetOSName {\r
    unless (defined $cached_os) {\r
	my($desc, $major, $minor, $build, $id, undef, undef, undef, $producttype)\r
	    = Win32::GetOSVersion();\r
	($cached_os, $cached_desc) = _GetOSName($desc, $major, $minor, $build, $id, $producttype);\r
    }\r
    return wantarray ? ($cached_os, $cached_desc) : $cached_os;\r
}\r
\r
sub _GetOSName {\r
    my($desc, $major, $minor, $build, $id, $producttype) = @_;\r
\r
    my($os,$tag);\r
    if ($id == 0) {\r
	$os = "Win32s";\r
    }\r
    elsif ($id == 1) {\r
	$os = { 0 => "95", 10 => "98", 90 => "Me" }->{$minor};\r
    }\r
    elsif ($id == 2) {\r
	if ($major == 3) {\r
	    $os = "NT3.51";\r
	}\r
	elsif ($major == 4) {\r
	    $os = "NT4";\r
	}\r
	elsif ($major == 5) {\r
	    $os = { 0 => "2000", 1 => "XP/.Net", 2 => "2003" }->{$minor};\r
	}\r
	elsif ($major == 6) {\r
	    $os = { 0 => "Vista", 1 => "7" }->{$minor};\r
	    # 2008 is same as Vista but has "Domaincontroller" or "Server" type\r
	    $os = "2008" if $os eq "Vista" && $producttype != 1;\r
	}\r
    }\r
\r
    unless (defined $os) {\r
	warn "Unknown Windows version [$id:$major:$minor]";\r
	return;\r
    }\r
\r
    # Take a look at the build numbers and try to deduce\r
    # the exact release name, but we put that in the $desc\r
    if ($os eq "95") {\r
	$tag = { 67109814 => "(a)", 67306684 => "(b1)", "67109975" => "(b2)" }->{$build};\r
    }\r
    elsif ($os eq "98" && $build eq "67766446") {\r
	$tag = "(2nd ed)";\r
    }\r
    if ($tag) {\r
	$desc = length($desc) ? "$tag $desc" : $tag;\r
    }\r
\r
     return ("Win$os", $desc);\r
}\r
\r
# "no warnings 'redefine';" doesn't work for 5.8.7 and earlier\r
local $^W = 0;\r
bootstrap Win32;\r
\r
1;\r
\r
__END__\r
\r
=head1 NAME\r
\r
Win32 - Interfaces to some Win32 API Functions\r
\r
=head1 DESCRIPTION\r
\r
The Win32 module contains functions to access Win32 APIs.\r
\r
=head2 Alphabetical Listing of Win32 Functions\r
\r
It is recommended to C<use Win32;> before any of these functions;\r
however, for backwards compatibility, those marked as [CORE] will\r
automatically do this for you.\r
\r
In the function descriptions below the term I<Unicode string> is used\r
to indicate that the string may contain characters outside the system\r
codepage.  The caveat I<If supported by the core Perl version>\r
generally means Perl 5.8.9 and later, though some Unicode pathname\r
functionality may work on earlier versions.\r
\r
=over\r
\r
=item Win32::AbortSystemShutdown(MACHINE)\r
\r
Aborts a system shutdown (started by the\r
InitiateSystemShutdown function) on the specified MACHINE.\r
\r
=item Win32::BuildNumber()\r
\r
[CORE] Returns the ActivePerl build number.  This function is\r
only available in the ActivePerl binary distribution.\r
\r
=item Win32::CopyFile(FROM, TO, OVERWRITE)\r
\r
[CORE] The Win32::CopyFile() function copies an existing file to a new\r
file.  All file information like creation time and file attributes will\r
be copied to the new file.  However it will B<not> copy the security\r
information.  If the destination file already exists it will only be\r
overwritten when the OVERWRITE parameter is true.  But even this will\r
not overwrite a read-only file; you have to unlink() it first\r
yourself.\r
\r
=item Win32::CreateDirectory(DIRECTORY)\r
\r
Creates the DIRECTORY and returns a true value on success.  Check $^E\r
on failure for extended error information.\r
\r
DIRECTORY may contain Unicode characters outside the system codepage.\r
Once the directory has been created you can use\r
Win32::GetANSIPathName() to get a name that can be passed to system\r
calls and external programs.\r
\r
=item Win32::CreateFile(FILE)\r
\r
Creates the FILE and returns a true value on success.  Check $^E on\r
failure for extended error information.\r
\r
FILE may contain Unicode characters outside the system codepage.  Once\r
the file has been created you can use Win32::GetANSIPathName() to get\r
a name that can be passed to system calls and external programs.\r
\r
=item Win32::DomainName()\r
\r
[CORE] Returns the name of the Microsoft Network domain or workgroup\r
that the owner of the current perl process is logged into.  The\r
"Workstation" service must be running to determine this\r
information.  This function does B<not> work on Windows 9x.\r
\r
=item Win32::ExpandEnvironmentStrings(STRING)\r
\r
Takes STRING and replaces all referenced environment variable\r
names with their defined values.  References to environment variables\r
take the form C<%VariableName%>.  Case is ignored when looking up the\r
VariableName in the environment.  If the variable is not found then the\r
original C<%VariableName%> text is retained.  Has the same effect\r
as the following:\r
\r
	$string =~ s/%([^%]*)%/$ENV{$1} || "%$1%"/eg\r
\r
However, this function may return a Unicode string if the environment\r
variable being expanded hasn't been assigned to via %ENV.  Access\r
to %ENV is currently always using byte semantics.\r
\r
=item Win32::FormatMessage(ERRORCODE)\r
\r
[CORE] Converts the supplied Win32 error number (e.g. returned by\r
Win32::GetLastError()) to a descriptive string.  Analogous to the\r
perror() standard-C library function.  Note that C<$^E> used\r
in a string context has much the same effect.\r
\r
	C:\> perl -e "$^E = 26; print $^E;"\r
	The specified disk or diskette cannot be accessed\r
\r
=item Win32::FsType()\r
\r
[CORE] Returns the name of the filesystem of the currently active\r
drive (like 'FAT' or 'NTFS').  In list context it returns three values:\r
(FSTYPE, FLAGS, MAXCOMPLEN).  FSTYPE is the filesystem type as\r
before.  FLAGS is a combination of values of the following table:\r
\r
	0x00000001  supports case-sensitive filenames\r
	0x00000002  preserves the case of filenames\r
	0x00000004  supports Unicode in filenames\r
	0x00000008  preserves and enforces ACLs\r
	0x00000010  supports file-based compression\r
	0x00000020  supports disk quotas\r
	0x00000040  supports sparse files\r
	0x00000080  supports reparse points\r
	0x00000100  supports remote storage\r
	0x00008000  is a compressed volume (e.g. DoubleSpace)\r
	0x00010000  supports object identifiers\r
	0x00020000  supports the Encrypted File System (EFS)\r
\r
MAXCOMPLEN is the maximum length of a filename component (the part\r
between two backslashes) on this file system.\r
\r
=item Win32::FreeLibrary(HANDLE)\r
\r
Unloads a previously loaded dynamic-link library.  The HANDLE is\r
no longer valid after this call.  See L<LoadLibrary|Win32::LoadLibrary(LIBNAME)>\r
for information on dynamically loading a library.\r
\r
=item Win32::GetANSIPathName(FILENAME)\r
\r
Returns an ANSI version of FILENAME.  This may be the short name\r
if the long name cannot be represented in the system codepage.\r
\r
While not currently implemented, it is possible that in the future\r
this function will convert only parts of the path to FILENAME to a\r
short form.\r
\r
If FILENAME doesn't exist on the filesystem, or if the filesystem\r
doesn't support short ANSI filenames, then this function will\r
translate the Unicode name into the system codepage using replacement\r
characters.\r
\r
=item Win32::GetArchName()\r
\r
Use of this function is deprecated.  It is equivalent with\r
$ENV{PROCESSOR_ARCHITECTURE}.  This might not work on Win9X.\r
\r
=item Win32::GetChipName()\r
\r
Returns the processor type: 386, 486 or 586 for Intel processors,\r
21064 for the Alpha chip.\r
\r
=item Win32::GetCwd()\r
\r
[CORE] Returns the current active drive and directory.  This function\r
does not return a UNC path, since the functionality required for such\r
a feature is not available under Windows 95.\r
\r
If supported by the core Perl version, this function will return an\r
ANSI path name for the current directory if the long pathname cannot\r
be represented in the system codepage.\r
\r
=item Win32::GetCurrentProcessId()\r
\r
Returns the process identifier of the current process.  Until the\r
process terminates, the process identifier uniquely identifies the\r
process throughout the system.\r
\r
The current process identifier is normally also available via the\r
predefined $$ variable.  Under fork() emulation however $$ may contain\r
a pseudo-process identifier that is only meaningful to the Perl\r
kill(), wait() and waitpid() functions.  The\r
Win32::GetCurrentProcessId() function will always return the regular\r
Windows process id, even when called from inside a pseudo-process.\r
\r
=item Win32::GetCurrentThreadId()\r
\r
Returns the thread identifier of the calling thread.  Until the thread\r
terminates, the thread identifier uniquely identifies the thread\r
throughout the system.\r
\r
=item Win32::GetFileVersion(FILENAME)\r
\r
Returns the file version number from the VERSIONINFO resource of\r
the executable file or DLL.  This is a tuple of four 16 bit numbers.\r
In list context these four numbers will be returned.  In scalar context\r
they are concatenated into a string, separated by dots.\r
\r
=item Win32::GetFolderPath(FOLDER [, CREATE])\r
\r
Returns the full pathname of one of the Windows special folders.\r
The folder will be created if it doesn't exist and the optional CREATE\r
argument is true.  The following FOLDER constants are defined by the\r
Win32 module, but only exported on demand:\r
\r
        CSIDL_ADMINTOOLS\r
        CSIDL_APPDATA\r
        CSIDL_CDBURN_AREA\r
        CSIDL_COMMON_ADMINTOOLS\r
        CSIDL_COMMON_APPDATA\r
        CSIDL_COMMON_DESKTOPDIRECTORY\r
        CSIDL_COMMON_DOCUMENTS\r
        CSIDL_COMMON_FAVORITES\r
        CSIDL_COMMON_MUSIC\r
        CSIDL_COMMON_PICTURES\r
        CSIDL_COMMON_PROGRAMS\r
        CSIDL_COMMON_STARTMENU\r
        CSIDL_COMMON_STARTUP\r
        CSIDL_COMMON_TEMPLATES\r
        CSIDL_COMMON_VIDEO\r
        CSIDL_COOKIES\r
        CSIDL_DESKTOP\r
        CSIDL_DESKTOPDIRECTORY\r
        CSIDL_FAVORITES\r
        CSIDL_FONTS\r
        CSIDL_HISTORY\r
        CSIDL_INTERNET_CACHE\r
        CSIDL_LOCAL_APPDATA\r
        CSIDL_MYMUSIC\r
        CSIDL_MYPICTURES\r
        CSIDL_MYVIDEO\r
        CSIDL_NETHOOD\r
        CSIDL_PERSONAL\r
        CSIDL_PRINTHOOD\r
        CSIDL_PROFILE\r
        CSIDL_PROGRAMS\r
        CSIDL_PROGRAM_FILES\r
        CSIDL_PROGRAM_FILES_COMMON\r
        CSIDL_RECENT\r
        CSIDL_RESOURCES\r
        CSIDL_RESOURCES_LOCALIZED\r
        CSIDL_SENDTO\r
        CSIDL_STARTMENU\r
        CSIDL_STARTUP\r
        CSIDL_SYSTEM\r
        CSIDL_TEMPLATES\r
        CSIDL_WINDOWS\r
\r
Note that not all folders are defined on all versions of Windows.\r
\r
Please refer to the MSDN documentation of the CSIDL constants,\r
currently available at:\r
\r
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/shellcc/platform/shell/reference/enums/csidl.asp\r
\r
This function will return an ANSI folder path if the long name cannot\r
be represented in the system codepage.  Use Win32::GetLongPathName()\r
on the result of Win32::GetFolderPath() if you want the Unicode\r
version of the folder name.\r
\r
=item Win32::GetFullPathName(FILENAME)\r
\r
[CORE] GetFullPathName combines the FILENAME with the current drive\r
and directory name and returns a fully qualified (aka, absolute)\r
path name.  In list context it returns two elements: (PATH, FILE) where\r
PATH is the complete pathname component (including trailing backslash)\r
and FILE is just the filename part.  Note that no attempt is made to\r
convert 8.3 components in the supplied FILENAME to longnames or\r
vice-versa.  Compare with Win32::GetShortPathName() and\r
Win32::GetLongPathName().\r
\r
If supported by the core Perl version, this function will return an\r
ANSI path name if the full pathname cannot be represented in the\r
system codepage.\r
\r
=item Win32::GetLastError()\r
\r
[CORE] Returns the last error value generated by a call to a Win32 API\r
function.  Note that C<$^E> used in a numeric context amounts to the\r
same value.\r
\r
=item Win32::GetLongPathName(PATHNAME)\r
\r
[CORE] Returns a representation of PATHNAME composed of longname\r
components (if any).  The result may not necessarily be longer\r
than PATHNAME.  No attempt is made to convert PATHNAME to the\r
absolute path.  Compare with Win32::GetShortPathName() and\r
Win32::GetFullPathName().\r
\r
This function may return the pathname in Unicode if it cannot be\r
represented in the system codepage.  Use Win32::GetANSIPathName()\r
before passing the path to a system call or another program.\r
\r
=item Win32::GetNextAvailDrive()\r
\r
[CORE] Returns a string in the form of "<d>:" where <d> is the first\r
available drive letter.\r
\r
=item Win32::GetOSVersion()\r
\r
[CORE] Returns the list (STRING, MAJOR, MINOR, BUILD, ID), where the\r
elements are, respectively: An arbitrary descriptive string, the major\r
version number of the operating system, the minor version number, the\r
build number, and a digit indicating the actual operating system.\r
For the ID, the values are 0 for Win32s, 1 for Windows 9X/Me and 2 for\r
Windows NT/2000/XP/2003/Vista/2008/7.  In scalar context it returns just\r
the ID.\r
\r
Currently known values for ID MAJOR and MINOR are as follows:\r
\r
    OS                    ID    MAJOR   MINOR\r
    Win32s                 0      -       -\r
    Windows 95             1      4       0\r
    Windows 98             1      4      10\r
    Windows Me             1      4      90\r
    Windows NT 3.51        2      3      51\r
    Windows NT 4           2      4       0\r
    Windows 2000           2      5       0\r
    Windows XP             2      5       1\r
    Windows Server 2003    2      5       2\r
    Windows Vista          2      6       0\r
    Windows Server 2008    2      6       0\r
    Windows 7              2      6       1\r
\r
On Windows NT 4 SP6 and later this function returns the following\r
additional values: SPMAJOR, SPMINOR, SUITEMASK, PRODUCTTYPE.\r
\r
The version numbers for Windows Vista and Windows Server 2008 are\r
identical; the PRODUCTTYPE field must be used to differentiate\r
between them.\r
\r
SPMAJOR and SPMINOR are are the version numbers of the latest\r
installed service pack.\r
\r
SUITEMASK is a bitfield identifying the product suites available on\r
the system.  Known bits are:\r
\r
    VER_SUITE_SMALLBUSINESS             0x00000001\r
    VER_SUITE_ENTERPRISE                0x00000002\r
    VER_SUITE_BACKOFFICE                0x00000004\r
    VER_SUITE_COMMUNICATIONS            0x00000008\r
    VER_SUITE_TERMINAL                  0x00000010\r
    VER_SUITE_SMALLBUSINESS_RESTRICTED  0x00000020\r
    VER_SUITE_EMBEDDEDNT                0x00000040\r
    VER_SUITE_DATACENTER                0x00000080\r
    VER_SUITE_SINGLEUSERTS              0x00000100\r
    VER_SUITE_PERSONAL                  0x00000200\r
    VER_SUITE_BLADE                     0x00000400\r
    VER_SUITE_EMBEDDED_RESTRICTED       0x00000800\r
    VER_SUITE_SECURITY_APPLIANCE        0x00001000\r
\r
The VER_SUITE_xxx names are listed here to crossreference the Microsoft\r
documentation.  The Win32 module does not provide symbolic names for these\r
constants.\r
\r
PRODUCTTYPE provides additional information about the system.  It should\r
be one of the following integer values:\r
\r
    1 - Workstation (NT 4, 2000 Pro, XP Home, XP Pro, Vista)\r
    2 - Domaincontroller\r
    3 - Server (2000 Server, Server 2003, Server 2008)\r
\r
Note that a server that is also a domain controller is reported as\r
PRODUCTTYPE 2 (Domaincontroller) and not PRODUCTTYPE 3 (Server).\r
\r
=item Win32::GetOSName()\r
\r
In scalar context returns the name of the Win32 operating system\r
being used.  In list context returns a two element list of the OS name\r
and whatever edition information is known about the particular build\r
(for Win9X boxes) and whatever service packs have been installed.\r
The latter is roughly equivalent to the first item returned by\r
GetOSVersion() in list context.\r
\r
Currently the possible values for the OS name are\r
\r
    WinWin32s\r
    Win95\r
    Win98\r
    WinMe\r
    WinNT3.51\r
    WinNT4\r
    Win2000\r
    WinXP/.Net\r
    Win2003\r
    WinVista\r
    Win2008\r
    Win7\r
\r
This routine is just a simple interface into GetOSVersion().  More\r
specific or demanding situations should use that instead.  Another\r
option would be to use POSIX::uname(), however the latter appears to\r
report only the OS family name and not the specific OS.  In scalar\r
context it returns just the ID.\r
\r
The name "WinXP/.Net" is used for historical reasons only, to maintain\r
backwards compatibility of the Win32 module.  Windows .NET Server has\r
been renamed as Windows 2003 Server before final release and uses a\r
different major/minor version number than Windows XP.\r
\r
Similarly the name "WinWin32s" should have been "Win32s" but has been\r
kept as-is for backwards compatibility reasons too.\r
\r
=item Win32::GetShortPathName(PATHNAME)\r
\r
[CORE] Returns a representation of PATHNAME that is composed of short\r
(8.3) path components where available.  For path components where the\r
file system has not generated the short form the returned path will\r
use the long form, so this function might still for instance return a\r
path containing spaces.  Returns C<undef> when the PATHNAME does not\r
exist. Compare with Win32::GetFullPathName() and\r
Win32::GetLongPathName().\r
\r
=item Win32::GetProcAddress(INSTANCE, PROCNAME)\r
\r
Returns the address of a function inside a loaded library.  The\r
information about what you can do with this address has been lost in\r
the mist of time.  Use the Win32::API module instead of this deprecated\r
function.\r
\r
=item Win32::GetTickCount()\r
\r
[CORE] Returns the number of milliseconds elapsed since the last\r
system boot.  Resolution is limited to system timer ticks (about 10ms\r
on WinNT and 55ms on Win9X).\r
\r
=item Win32::GuidGen()\r
\r
Creates a globally unique 128 bit integer that can be used as a\r
persistent identifier in a distributed setting. To a very high degree\r
of certainty this function returns a unique value. No other\r
invocation, on the same or any other system (networked or not), should\r
return the same value.\r
\r
The return value is formatted according to OLE conventions, as groups\r
of hex digits with surrounding braces.  For example:\r
\r
    {09531CF1-D0C7-4860-840C-1C8C8735E2AD}\r
 \r
=item Win32::InitiateSystemShutdown\r
\r
(MACHINE, MESSAGE, TIMEOUT, FORCECLOSE, REBOOT)\r
\r
Shutsdown the specified MACHINE, notifying users with the\r
supplied MESSAGE, within the specified TIMEOUT interval.  Forces\r
closing of all documents without prompting the user if FORCECLOSE is\r
true, and reboots the machine if REBOOT is true.  This function works\r
only on WinNT.\r
\r
=item Win32::IsAdminUser()\r
\r
Returns non zero if the account in whose security context the\r
current process/thread is running belongs to the local group of\r
Administrators in the built-in system domain; returns 0 if not.\r
On Windows Vista it will only return non-zero if the process is\r
actually running with elevated privileges.  Returns C<undef>\r
and prints a warning if an error occurred.  This function always\r
returns 1 on Win9X.\r
\r
=item Win32::IsWinNT()\r
\r
[CORE] Returns non zero if the Win32 subsystem is Windows NT.\r
\r
=item Win32::IsWin95()\r
\r
[CORE] Returns non zero if the Win32 subsystem is Windows 95.\r
\r
=item Win32::LoadLibrary(LIBNAME)\r
\r
Loads a dynamic link library into memory and returns its module\r
handle.  This handle can be used with Win32::GetProcAddress() and\r
Win32::FreeLibrary().  This function is deprecated.  Use the Win32::API\r
module instead.\r
\r
=item Win32::LoginName()\r
\r
[CORE] Returns the username of the owner of the current perl process.\r
The return value may be a Unicode string.\r
\r
=item Win32::LookupAccountName(SYSTEM, ACCOUNT, DOMAIN, SID, SIDTYPE)\r
\r
Looks up ACCOUNT on SYSTEM and returns the domain name the SID and\r
the SID type.\r
\r
=item Win32::LookupAccountSID(SYSTEM, SID, ACCOUNT, DOMAIN, SIDTYPE)\r
\r
Looks up SID on SYSTEM and returns the account name, domain name,\r
and the SID type.\r
\r
=item Win32::MsgBox(MESSAGE [, FLAGS [, TITLE]])\r
\r
Create a dialogbox containing MESSAGE.  FLAGS specifies the\r
required icon and buttons according to the following table:\r
\r
	0 = OK\r
	1 = OK and Cancel\r
	2 = Abort, Retry, and Ignore\r
	3 = Yes, No and Cancel\r
	4 = Yes and No\r
	5 = Retry and Cancel\r
\r
	MB_ICONSTOP          "X" in a red circle\r
	MB_ICONQUESTION      question mark in a bubble\r
	MB_ICONEXCLAMATION   exclamation mark in a yellow triangle\r
	MB_ICONINFORMATION   "i" in a bubble\r
\r
TITLE specifies an optional window title.  The default is "Perl".\r
\r
The function returns the menu id of the selected push button:\r
\r
	0  Error\r
\r
	1  OK\r
	2  Cancel\r
	3  Abort\r
	4  Retry\r
	5  Ignore\r
	6  Yes\r
	7  No\r
\r
=item Win32::NodeName()\r
\r
[CORE] Returns the Microsoft Network node-name of the current machine.\r
\r
=item Win32::OutputDebugString(STRING)\r
\r
Sends a string to the application or system debugger for display.\r
The function does nothing if there is no active debugger.\r
\r
Alternatively one can use the I<Debug Viewer> application to\r
watch the OutputDebugString() output:\r
\r
http://www.microsoft.com/technet/sysinternals/utilities/debugview.mspx\r
\r
=item Win32::RegisterServer(LIBRARYNAME)\r
\r
Loads the DLL LIBRARYNAME and calls the function DllRegisterServer.\r
\r
=item Win32::SetChildShowWindow(SHOWWINDOW)\r
\r
[CORE] Sets the I<ShowMode> of child processes started by system().\r
By default system() will create a new console window for child\r
processes if Perl itself is not running from a console.  Calling\r
SetChildShowWindow(0) will make these new console windows invisible.\r
Calling SetChildShowWindow() without arguments reverts system() to the\r
default behavior.  The return value of SetChildShowWindow() is the\r
previous setting or C<undef>.\r
\r
The following symbolic constants for SHOWWINDOW are available\r
(but not exported) from the Win32 module: SW_HIDE, SW_SHOWNORMAL,\r
SW_SHOWMINIMIZED, SW_SHOWMAXIMIZED and SW_SHOWNOACTIVATE.\r
\r
=item Win32::SetCwd(NEWDIRECTORY)\r
\r
[CORE] Sets the current active drive and directory.  This function does not\r
work with UNC paths, since the functionality required to required for\r
such a feature is not available under Windows 95.\r
\r
=item Win32::SetLastError(ERROR)\r
\r
[CORE] Sets the value of the last error encountered to ERROR.  This is\r
that value that will be returned by the Win32::GetLastError()\r
function.\r
\r
=item Win32::Sleep(TIME)\r
\r
[CORE] Pauses for TIME milliseconds.  The timeslices are made available\r
to other processes and threads.\r
\r
=item Win32::Spawn(COMMAND, ARGS, PID)\r
\r
[CORE] Spawns a new process using the supplied COMMAND, passing in\r
arguments in the string ARGS.  The pid of the new process is stored in\r
PID.  This function is deprecated.  Please use the Win32::Process module\r
instead.\r
\r
=item Win32::UnregisterServer(LIBRARYNAME)\r
\r
Loads the DLL LIBRARYNAME and calls the function\r
DllUnregisterServer.\r
\r
=back\r
\r
=cut\r