ext/Win32/Win32.pm

   1 package Win32;
   2
   3 BEGIN {
   4     use strict;
   5     use vars qw|$VERSION $XS_VERSION @ISA @EXPORT @EXPORT_OK|;
   6
   7     require Exporter;
   8     require DynaLoader;
   9
  10     @ISA = qw|Exporter DynaLoader|;
  11     $VERSION = '0.31';
  12     $XS_VERSION = $VERSION;
  13     $VERSION = eval $VERSION;
  14
  15     @EXPORT = qw(
  16         NULL
  17         WIN31_CLASS
  18         OWNER_SECURITY_INFORMATION
  19         GROUP_SECURITY_INFORMATION
  20         DACL_SECURITY_INFORMATION
  21         SACL_SECURITY_INFORMATION
  22         MB_ICONHAND
  23         MB_ICONQUESTION
  24         MB_ICONEXCLAMATION
  25         MB_ICONASTERISK
  26         MB_ICONWARNING
  27         MB_ICONERROR
  28         MB_ICONINFORMATION
  29         MB_ICONSTOP
  30     );
  31     @EXPORT_OK = qw(
  32         GetOSName
  33         SW_HIDE
  34         SW_SHOWNORMAL
  35         SW_SHOWMINIMIZED
  36         SW_SHOWMAXIMIZED
  37         SW_SHOWNOACTIVATE
  38
  39         CSIDL_DESKTOP
  40         CSIDL_PROGRAMS
  41         CSIDL_PERSONAL
  42         CSIDL_FAVORITES
  43         CSIDL_STARTUP
  44         CSIDL_RECENT
  45         CSIDL_SENDTO
  46         CSIDL_STARTMENU
  47         CSIDL_MYMUSIC
  48         CSIDL_MYVIDEO
  49         CSIDL_DESKTOPDIRECTORY
  50         CSIDL_NETHOOD
  51         CSIDL_FONTS
  52         CSIDL_TEMPLATES
  53         CSIDL_COMMON_STARTMENU
  54         CSIDL_COMMON_PROGRAMS
  55         CSIDL_COMMON_STARTUP
  56         CSIDL_COMMON_DESKTOPDIRECTORY
  57         CSIDL_APPDATA
  58         CSIDL_PRINTHOOD
  59         CSIDL_LOCAL_APPDATA
  60         CSIDL_COMMON_FAVORITES
  61         CSIDL_INTERNET_CACHE
  62         CSIDL_COOKIES
  63         CSIDL_HISTORY
  64         CSIDL_COMMON_APPDATA
  65         CSIDL_WINDOWS
  66         CSIDL_SYSTEM
  67         CSIDL_PROGRAM_FILES
  68         CSIDL_MYPICTURES
  69         CSIDL_PROFILE
  70         CSIDL_PROGRAM_FILES_COMMON
  71         CSIDL_COMMON_TEMPLATES
  72         CSIDL_COMMON_DOCUMENTS
  73         CSIDL_COMMON_ADMINTOOLS
  74         CSIDL_ADMINTOOLS
  75         CSIDL_COMMON_MUSIC
  76         CSIDL_COMMON_PICTURES
  77         CSIDL_COMMON_VIDEO
  78         CSIDL_RESOURCES
  79         CSIDL_RESOURCES_LOCALIZED
  80         CSIDL_CDBURN_AREA
  81     );
  82 }
  83
  84 # We won't bother with the constant stuff, too much of a hassle.  Just hard
  85 # code it here.
  86
  87 sub NULL                                { 0 }
  88 sub WIN31_CLASS                         { &NULL }
  89
  90 sub OWNER_SECURITY_INFORMATION          { 0x00000001 }
  91 sub GROUP_SECURITY_INFORMATION          { 0x00000002 }
  92 sub DACL_SECURITY_INFORMATION           { 0x00000004 }
  93 sub SACL_SECURITY_INFORMATION           { 0x00000008 }
  94
  95 sub MB_ICONHAND                         { 0x00000010 }
  96 sub MB_ICONQUESTION                     { 0x00000020 }
  97 sub MB_ICONEXCLAMATION                  { 0x00000030 }
  98 sub MB_ICONASTERISK                     { 0x00000040 }
  99 sub MB_ICONWARNING                      { 0x00000030 }
 100 sub MB_ICONERROR                        { 0x00000010 }
 101 sub MB_ICONINFORMATION                  { 0x00000040 }
 102 sub MB_ICONSTOP                         { 0x00000010 }
 103
 104 #
 105 # Newly added constants.  These have an empty prototype, unlike the
 106 # the ones above, which aren't prototyped for compatibility reasons.
 107 #
 108 sub SW_HIDE           ()                { 0 }
 109 sub SW_SHOWNORMAL     ()                { 1 }
 110 sub SW_SHOWMINIMIZED  ()                { 2 }
 111 sub SW_SHOWMAXIMIZED  ()                { 3 }
 112 sub SW_SHOWNOACTIVATE ()                { 4 }
 113
 114 sub CSIDL_DESKTOP              ()       { 0x0000 }     # <desktop>
 115 sub CSIDL_PROGRAMS             ()       { 0x0002 }     # Start Menu\Programs
 116 sub CSIDL_PERSONAL             ()       { 0x0005 }     # "My Documents" folder
 117 sub CSIDL_FAVORITES            ()       { 0x0006 }     # <user name>\Favorites
 118 sub CSIDL_STARTUP              ()       { 0x0007 }     # Start Menu\Programs\Startup
 119 sub CSIDL_RECENT               ()       { 0x0008 }     # <user name>\Recent
 120 sub CSIDL_SENDTO               ()       { 0x0009 }     # <user name>\SendTo
 121 sub CSIDL_STARTMENU            ()       { 0x000B }     # <user name>\Start Menu
 122 sub CSIDL_MYMUSIC              ()       { 0x000D }     # "My Music" folder
 123 sub CSIDL_MYVIDEO              ()       { 0x000E }     # "My Videos" folder
 124 sub CSIDL_DESKTOPDIRECTORY     ()       { 0x0010 }     # <user name>\Desktop
 125 sub CSIDL_NETHOOD              ()       { 0x0013 }     # <user name>\nethood
 126 sub CSIDL_FONTS                ()       { 0x0014 }     # windows\fonts
 127 sub CSIDL_TEMPLATES            ()       { 0x0015 }
 128 sub CSIDL_COMMON_STARTMENU     ()       { 0x0016 }     # All Users\Start Menu
 129 sub CSIDL_COMMON_PROGRAMS      ()       { 0x0017 }     # All Users\Start Menu\Programs
 130 sub CSIDL_COMMON_STARTUP       ()       { 0x0018 }     # All Users\Startup
 131 sub CSIDL_COMMON_DESKTOPDIRECTORY ()    { 0x0019 }     # All Users\Desktop
 132 sub CSIDL_APPDATA              ()       { 0x001A }     # Application Data, new for NT4
 133 sub CSIDL_PRINTHOOD            ()       { 0x001B }     # <user name>\PrintHood
 134 sub CSIDL_LOCAL_APPDATA        ()       { 0x001C }     # non roaming, user\Local Settings\Application Data
 135 sub CSIDL_COMMON_FAVORITES     ()       { 0x001F }
 136 sub CSIDL_INTERNET_CACHE       ()       { 0x0020 }
 137 sub CSIDL_COOKIES              ()       { 0x0021 }
 138 sub CSIDL_HISTORY              ()       { 0x0022 }
 139 sub CSIDL_COMMON_APPDATA       ()       { 0x0023 }     # All Users\Application Data
 140 sub CSIDL_WINDOWS              ()       { 0x0024 }     # GetWindowsDirectory()
 141 sub CSIDL_SYSTEM               ()       { 0x0025 }     # GetSystemDirectory()
 142 sub CSIDL_PROGRAM_FILES        ()       { 0x0026 }     # C:\Program Files
 143 sub CSIDL_MYPICTURES           ()       { 0x0027 }     # "My Pictures", new for Win2K
 144 sub CSIDL_PROFILE              ()       { 0x0028 }     # USERPROFILE
 145 sub CSIDL_PROGRAM_FILES_COMMON ()       { 0x002B }     # C:\Program Files\Common
 146 sub CSIDL_COMMON_TEMPLATES     ()       { 0x002D }     # All Users\Templates
 147 sub CSIDL_COMMON_DOCUMENTS     ()       { 0x002E }     # All Users\Documents
 148 sub CSIDL_COMMON_ADMINTOOLS    ()       { 0x002F }     # All Users\Start Menu\Programs\Administrative Tools
 149 sub CSIDL_ADMINTOOLS           ()       { 0x0030 }     # <user name>\Start Menu\Programs\Administrative Tools
 150 sub CSIDL_COMMON_MUSIC         ()       { 0x0035 }     # All Users\My Music
 151 sub CSIDL_COMMON_PICTURES      ()       { 0x0036 }     # All Users\My Pictures
 152 sub CSIDL_COMMON_VIDEO         ()       { 0x0037 }     # All Users\My Video
 153 sub CSIDL_RESOURCES            ()       { 0x0038 }     # %windir%\Resources\, For theme and other windows resources.
 154 sub CSIDL_RESOURCES_LOCALIZED  ()       { 0x0039 }     # %windir%\Resources\<LangID>, for theme and other windows specific resources.
 155 sub CSIDL_CDBURN_AREA          ()       { 0x003B }     # <user name>\Local Settings\Application Data\Microsoft\CD Burning
 156
 157 ### This method is just a simple interface into GetOSVersion().  More
 158 ### specific or demanding situations should use that instead.
 159
 160 my ($found_os, $found_desc);
 161
 162 sub GetOSName {
 163     my ($os,$desc,$major, $minor, $build, $id)=("","");
 164     unless (defined $found_os) {
 165         # If we have a run this already, we have the results cached
 166         # If so, return them
 167
 168         # Use the standard API call to determine the version
 169         ($desc, $major, $minor, $build, $id) = Win32::GetOSVersion();
 170
 171         # If id==0 then its a win32s box -- Meaning Win3.11
 172         unless($id) {
 173             $os = 'Win32s';
 174         }
 175         else {
 176             # Magic numbers from MSDN documentation of OSVERSIONINFO
 177             # Most version names can be parsed from just the id and minor
 178             # version
 179             $os = {
 180                 1 => {
 181                     0  => "95",
 182                     10 => "98",
 183                     90 => "Me"
 184                 },
 185                 2 => {
 186                     0  => "NT4",
 187                     1  => "XP/.Net",
 188                     2  => "2003",
 189                     51 => "NT3.51"
 190                 }
 191             }->{$id}->{$minor};
 192         }
 193
 194         # This _really_ shouldnt happen.  At least not for quite a while
 195         # Politely warn and return undef
 196         unless (defined $os) {
 197             warn qq[Windows version [$id:$major:$minor] unknown!];
 198             return undef;
 199         }
 200
 201         my $tag = "";
 202
 203         # But distinguising W2k and Vista from NT4 requires looking at the major version
 204         if ($os eq "NT4") {
 205             $os = {5 => "2000", 6 => "Vista"}->{$major} || "NT4";
 206         }
 207
 208         # For the rest we take a look at the build numbers and try to deduce
 209         # the exact release name, but we put that in the $desc
 210         elsif ($os eq "95") {
 211             if ($build eq '67109814') {
 212                     $tag = '(a)';
 213             }
 214             elsif ($build eq '67306684') {
 215                     $tag = '(b1)';
 216             }
 217             elsif ($build eq '67109975') {
 218                     $tag = '(b2)';
 219             }
 220         }
 221         elsif ($os eq "98" && $build eq '67766446') {
 222             $tag = '(2nd ed)';
 223         }
 224
 225         if (length $tag) {
 226             if (length $desc) {
 227                 $desc = "$tag $desc";
 228             }
 229             else {
 230                 $desc = $tag;
 231             }
 232         }
 233
 234         # cache the results, so we dont have to do this again
 235         $found_os      = "Win$os";
 236         $found_desc    = $desc;
 237     }
 238
 239     return wantarray ? ($found_os, $found_desc) : $found_os;
 240 }
 241
 242 # "no warnings 'redefine';" doesn't work for 5.8.7 and earlier
 243 local $^W = 0;
 244 bootstrap Win32;
 245
 246 1;
 247
 248 __END__
 249
 250 =head1 NAME
 251
 252 Win32 - Interfaces to some Win32 API Functions
 253
 254 =head1 DESCRIPTION
 255
 256 The Win32 module contains functions to access Win32 APIs.
 257
 258 =head2 Alphabetical Listing of Win32 Functions
 259
 260 It is recommended to C<use Win32;> before any of these functions;
 261 however, for backwards compatibility, those marked as [CORE] will
 262 automatically do this for you.
 263
 264 In the function descriptions below the term I<Unicode string> is used
 265 to indicate that the string may contain characters outside the system
 266 codepage.  The caveat I<If supported by the core Perl version>
 267 generally means Perl 5.8.9 and later, though some Unicode pathname
 268 functionality may work on earlier versions.
 269
 270 =over
 271
 272 =item Win32::AbortSystemShutdown(MACHINE)
 273
 274 Aborts a system shutdown (started by the
 275 InitiateSystemShutdown function) on the specified MACHINE.
 276
 277 =item Win32::BuildNumber()
 278
 279 [CORE] Returns the ActivePerl build number.  This function is
 280 only available in the ActivePerl binary distribution.
 281
 282 =item Win32::CopyFile(FROM, TO, OVERWRITE)
 283
 284 [CORE] The Win32::CopyFile() function copies an existing file to a new
 285 file.  All file information like creation time and file attributes will
 286 be copied to the new file.  However it will B<not> copy the security
 287 information.  If the destination file already exists it will only be
 288 overwritten when the OVERWRITE parameter is true.  But even this will
 289 not overwrite a read-only file; you have to unlink() it first
 290 yourself.
 291
 292 =item Win32::CreateDirectory(DIRECTORY)
 293
 294 Creates the DIRECTORY and returns a true value on success.  Check $^E
 295 on failure for extended error information.
 296
 297 DIRECTORY may contain Unicode characters outside the system codepage.
 298 Once the directory has been created you can use
 299 Win32::GetANSIPathName() to get a name that can be passed to system
 300 calls and external programs.
 301
 302 =item Win32::CreateFile(FILE)
 303
 304 Creates the FILE and returns a true value on success.  Check $^E on
 305 failure for extended error information.
 306
 307 FILE may contain Unicode characters outside the system codepage.  Once
 308 the file has been created you can use Win32::GetANSIPathName() to get
 309 a name that can be passed to system calls and external programs.
 310
 311 =item Win32::DomainName()
 312
 313 [CORE] Returns the name of the Microsoft Network domain that the
 314 owner of the current perl process is logged into.  This function does
 315 B<not> work on Windows 9x.
 316
 317 =item Win32::ExpandEnvironmentStrings(STRING)
 318
 319 Takes STRING and replaces all referenced environment variable
 320 names with their defined values.  References to environment variables
 321 take the form C<%VariableName%>.  Case is ignored when looking up the
 322 VariableName in the environment.  If the variable is not found then the
 323 original C<%VariableName%> text is retained.  Has the same effect
 324 as the following:
 325
 326         $string =~ s/%([^%]*)%/$ENV{$1} || "%$1%"/eg
 327
 328 However, this function may return a Unicode string if the environment
 329 variable being expanded hasn't been assigned to via %ENV.  Access
 330 to %ENV is currently always using byte semantics.
 331
 332 =item Win32::FormatMessage(ERRORCODE)
 333
 334 [CORE] Converts the supplied Win32 error number (e.g. returned by
 335 Win32::GetLastError()) to a descriptive string.  Analogous to the
 336 perror() standard-C library function.  Note that C<$^E> used
 337 in a string context has much the same effect.
 338
 339         C:\> perl -e "$^E = 26; print $^E;"
 340         The specified disk or diskette cannot be accessed
 341
 342 =item Win32::FsType()
 343
 344 [CORE] Returns the name of the filesystem of the currently active
 345 drive (like 'FAT' or 'NTFS').  In list context it returns three values:
 346 (FSTYPE, FLAGS, MAXCOMPLEN).  FSTYPE is the filesystem type as
 347 before.  FLAGS is a combination of values of the following table:
 348
 349         0x00000001  supports case-sensitive filenames
 350         0x00000002  preserves the case of filenames
 351         0x00000004  supports Unicode in filenames
 352         0x00000008  preserves and enforces ACLs
 353         0x00000010  supports file-based compression
 354         0x00000020  supports disk quotas
 355         0x00000040  supports sparse files
 356         0x00000080  supports reparse points
 357         0x00000100  supports remote storage
 358         0x00008000  is a compressed volume (e.g. DoubleSpace)
 359         0x00010000  supports object identifiers
 360         0x00020000  supports the Encrypted File System (EFS)
 361
 362 MAXCOMPLEN is the maximum length of a filename component (the part
 363 between two backslashes) on this file system.
 364
 365 =item Win32::FreeLibrary(HANDLE)
 366
 367 Unloads a previously loaded dynamic-link library.  The HANDLE is
 368 no longer valid after this call.  See L<LoadLibrary|Win32::LoadLibrary(LIBNAME)>
 369 for information on dynamically loading a library.
 370
 371 =item Win32::GetANSIPathName(FILENAME)
 372
 373 Returns an ANSI version of FILENAME.  This may be the short name
 374 if the long name cannot be represented in the system codepage.
 375
 376 While not currently implemented, it is possible that in the future
 377 this function will convert only parts of the path to FILENAME to a
 378 short form.
 379
 380 If FILENAME doesn't exist on the filesystem, or if the filesystem
 381 doesn't support short ANSI filenames, then this function will
 382 translate the Unicode name into the system codepage using replacement
 383 characters.
 384
 385 =item Win32::GetArchName()
 386
 387 Use of this function is deprecated.  It is equivalent with
 388 $ENV{PROCESSOR_ARCHITECTURE}.  This might not work on Win9X.
 389
 390 =item Win32::GetChipName()
 391
 392 Returns the processor type: 386, 486 or 586 for Intel processors,
 393 21064 for the Alpha chip.
 394
 395 =item Win32::GetCwd()
 396
 397 [CORE] Returns the current active drive and directory.  This function
 398 does not return a UNC path, since the functionality required for such
 399 a feature is not available under Windows 95.
 400
 401 If supported by the core Perl version, this function will return an
 402 ANSI path name for the current directory if the long pathname cannot
 403 be represented in the system codepage.
 404
 405 =item Win32::GetCurrentThreadId()
 406
 407 Returns the thread identifier of the calling thread.  Until the thread
 408 terminates, the thread identifier uniquely identifies the thread
 409 throughout the system.
 410
 411 Note: the current process identifier is available via the predefined
 412 $$ variable.
 413
 414 =item Win32::GetFileVersion(FILENAME)
 415
 416 Returns the file version number from the VERSIONINFO resource of
 417 the executable file or DLL.  This is a tuple of four 16 bit numbers.
 418 In list context these four numbers will be returned.  In scalar context
 419 they are concatenated into a string, separated by dots.
 420
 421 =item Win32::GetFolderPath(FOLDER [, CREATE])
 422
 423 Returns the full pathname of one of the Windows special folders.
 424 The folder will be created if it doesn't exist and the optional CREATE
 425 argument is true.  The following FOLDER constants are defined by the
 426 Win32 module, but only exported on demand:
 427
 428         CSIDL_ADMINTOOLS
 429         CSIDL_APPDATA
 430         CSIDL_CDBURN_AREA
 431         CSIDL_COMMON_ADMINTOOLS
 432         CSIDL_COMMON_APPDATA
 433         CSIDL_COMMON_DESKTOPDIRECTORY
 434         CSIDL_COMMON_DOCUMENTS
 435         CSIDL_COMMON_FAVORITES
 436         CSIDL_COMMON_MUSIC
 437         CSIDL_COMMON_PICTURES
 438         CSIDL_COMMON_PROGRAMS
 439         CSIDL_COMMON_STARTMENU
 440         CSIDL_COMMON_STARTUP
 441         CSIDL_COMMON_TEMPLATES
 442         CSIDL_COMMON_VIDEO
 443         CSIDL_COOKIES
 444         CSIDL_DESKTOP
 445         CSIDL_DESKTOPDIRECTORY
 446         CSIDL_FAVORITES
 447         CSIDL_FONTS
 448         CSIDL_HISTORY
 449         CSIDL_INTERNET_CACHE
 450         CSIDL_LOCAL_APPDATA
 451         CSIDL_MYMUSIC
 452         CSIDL_MYPICTURES
 453         CSIDL_MYVIDEO
 454         CSIDL_NETHOOD
 455         CSIDL_PERSONAL
 456         CSIDL_PRINTHOOD
 457         CSIDL_PROFILE
 458         CSIDL_PROGRAMS
 459         CSIDL_PROGRAM_FILES
 460         CSIDL_PROGRAM_FILES_COMMON
 461         CSIDL_RECENT
 462         CSIDL_RESOURCES
 463         CSIDL_RESOURCES_LOCALIZED
 464         CSIDL_SENDTO
 465         CSIDL_STARTMENU
 466         CSIDL_STARTUP
 467         CSIDL_SYSTEM
 468         CSIDL_TEMPLATES
 469         CSIDL_WINDOWS
 470
 471 Note that not all folders are defined on all versions of Windows.
 472
 473 Please refer to the MSDN documentation of the CSIDL constants,
 474 currently available at:
 475
 476 http://msdn.microsoft.com/library/default.asp?url=/library/en-us/shellcc/platform/shell/reference/enums/csidl.asp
 477
 478 This function will return an ANSI folder path if the long name cannot
 479 be represented in the system codepage.  Use Win32::GetLongPathName()
 480 on the result of Win32::GetFolderPath() if you want the Unicode
 481 version of the folder name.
 482
 483 =item Win32::GetFullPathName(FILENAME)
 484
 485 [CORE] GetFullPathName combines the FILENAME with the current drive
 486 and directory name and returns a fully qualified (aka, absolute)
 487 path name.  In list context it returns two elements: (PATH, FILE) where
 488 PATH is the complete pathname component (including trailing backslash)
 489 and FILE is just the filename part.  Note that no attempt is made to
 490 convert 8.3 components in the supplied FILENAME to longnames or
 491 vice-versa.  Compare with Win32::GetShortPathName() and
 492 Win32::GetLongPathName().
 493
 494 If supported by the core Perl version, this function will return an
 495 ANSI path name if the full pathname cannot be represented in the
 496 system codepage.
 497
 498 =item Win32::GetLastError()
 499
 500 [CORE] Returns the last error value generated by a call to a Win32 API
 501 function.  Note that C<$^E> used in a numeric context amounts to the
 502 same value.
 503
 504 =item Win32::GetLongPathName(PATHNAME)
 505
 506 [CORE] Returns a representation of PATHNAME composed of longname
 507 components (if any).  The result may not necessarily be longer
 508 than PATHNAME.  No attempt is made to convert PATHNAME to the
 509 absolute path.  Compare with Win32::GetShortPathName() and
 510 Win32::GetFullPathName().
 511
 512 This function may return the pathname in Unicode if it cannot be
 513 represented in the system codepage.  Use Win32::GetANSIPathName()
 514 before passing the path to a system call or another program.
 515
 516 =item Win32::GetNextAvailDrive()
 517
 518 [CORE] Returns a string in the form of "<d>:" where <d> is the first
 519 available drive letter.
 520
 521 =item Win32::GetOSVersion()
 522
 523 [CORE] Returns the list (STRING, MAJOR, MINOR, BUILD, ID), where the
 524 elements are, respectively: An arbitrary descriptive string, the major
 525 version number of the operating system, the minor version number, the
 526 build number, and a digit indicating the actual operating system.
 527 For the ID, the values are 0 for Win32s, 1 for Windows 9X/Me and 2 for
 528 Windows NT/2000/XP/2003.  In scalar context it returns just the ID.
 529
 530 Currently known values for ID MAJOR and MINOR are as follows:
 531
 532     OS                    ID    MAJOR   MINOR
 533     Win32s                 0      -       -
 534     Windows 95             1      4       0
 535     Windows 98             1      4      10
 536     Windows Me             1      4      90
 537     Windows NT 3.51        2      3      51
 538     Windows NT 4           2      4       0
 539     Windows 2000           2      5       0
 540     Windows XP             2      5       1
 541     Windows Server 2003    2      5       2
 542     Windows Vista          2      6       0
 543
 544 On Windows NT 4 SP6 and later this function returns the following
 545 additional values: SPMAJOR, SPMINOR, SUITEMASK, PRODUCTTYPE.
 546
 547 SPMAJOR and SPMINOR are are the version numbers of the latest
 548 installed service pack.
 549
 550 SUITEMASK is a bitfield identifying the product suites available on
 551 the system.  Known bits are:
 552
 553     VER_SUITE_SMALLBUSINESS             0x00000001
 554     VER_SUITE_ENTERPRISE                0x00000002
 555     VER_SUITE_BACKOFFICE                0x00000004
 556     VER_SUITE_COMMUNICATIONS            0x00000008
 557     VER_SUITE_TERMINAL                  0x00000010
 558     VER_SUITE_SMALLBUSINESS_RESTRICTED  0x00000020
 559     VER_SUITE_EMBEDDEDNT                0x00000040
 560     VER_SUITE_DATACENTER                0x00000080
 561     VER_SUITE_SINGLEUSERTS              0x00000100
 562     VER_SUITE_PERSONAL                  0x00000200
 563     VER_SUITE_BLADE                     0x00000400
 564     VER_SUITE_EMBEDDED_RESTRICTED       0x00000800
 565     VER_SUITE_SECURITY_APPLIANCE        0x00001000
 566
 567 The VER_SUITE_xxx names are listed here to crossreference the Microsoft
 568 documentation.  The Win32 module does not provide symbolic names for these
 569 constants.
 570
 571 PRODUCTTYPE provides additional information about the system.  It should
 572 be one of the following integer values:
 573
 574     1 - Workstation (NT 4, 2000 Pro, XP Home, XP Pro)
 575     2 - Domaincontroller
 576     3 - Server
 577
 578 =item Win32::GetOSName()
 579
 580 In scalar context returns the name of the Win32 operating system
 581 being used.  In list context returns a two element list of the OS name
 582 and whatever edition information is known about the particular build
 583 (for Win9X boxes) and whatever service packs have been installed.
 584 The latter is roughly equivalent to the first item returned by
 585 GetOSVersion() in list context.
 586
 587 Currently the possible values for the OS name are
 588
 589  Win32s Win95 Win98 WinMe WinNT3.51 WinNT4 Win2000 WinXP/.Net Win2003
 590
 591 This routine is just a simple interface into GetOSVersion().  More
 592 specific or demanding situations should use that instead.  Another
 593 option would be to use POSIX::uname(), however the latter appears to
 594 report only the OS family name and not the specific OS.  In scalar
 595 context it returns just the ID.
 596
 597 The name "WinXP/.Net" is used for historical reasons only, to maintain
 598 backwards compatibility of the Win32 module.  Windows .NET Server has
 599 been renamed as Windows 2003 Server before final release and uses a
 600 different major/minor version number than Windows XP.
 601
 602 =item Win32::GetShortPathName(PATHNAME)
 603
 604 [CORE] Returns a representation of PATHNAME that is composed of short
 605 (8.3) path components where available.  For path components where the
 606 file system has not generated the short form the returned path will
 607 use the long form, so this function might still for instance return a
 608 path containing spaces.  Returns C<undef> when the PATHNAME does not
 609 exist. Compare with Win32::GetFullPathName() and
 610 Win32::GetLongPathName().
 611
 612 =item Win32::GetProcAddress(INSTANCE, PROCNAME)
 613
 614 Returns the address of a function inside a loaded library.  The
 615 information about what you can do with this address has been lost in
 616 the mist of time.  Use the Win32::API module instead of this deprecated
 617 function.
 618
 619 =item Win32::GetTickCount()
 620
 621 [CORE] Returns the number of milliseconds elapsed since the last
 622 system boot.  Resolution is limited to system timer ticks (about 10ms
 623 on WinNT and 55ms on Win9X).
 624
 625 =item Win32::GuidGen()
 626
 627 Creates a globally unique 128 bit integer that can be used as a
 628 persistent identifier in a distributed setting. To a very high degree
 629 of certainty this function returns a unique value. No other
 630 invocation, on the same or any other system (networked or not), should
 631 return the same value.
 632
 633 The return value is formatted according to OLE conventions, as groups
 634 of hex digits with surrounding braces.  For example:
 635
 636     {09531CF1-D0C7-4860-840C-1C8C8735E2AD}
 637
 638 =item Win32::InitiateSystemShutdown
 639
 640 (MACHINE, MESSAGE, TIMEOUT, FORCECLOSE, REBOOT)
 641
 642 Shutsdown the specified MACHINE, notifying users with the
 643 supplied MESSAGE, within the specified TIMEOUT interval.  Forces
 644 closing of all documents without prompting the user if FORCECLOSE is
 645 true, and reboots the machine if REBOOT is true.  This function works
 646 only on WinNT.
 647
 648 =item Win32::IsAdminUser()
 649
 650 Returns non zero if the account in whose security context the
 651 current process/thread is running belongs to the local group of
 652 Administrators in the built-in system domain; returns 0 if not.
 653 On Windows Vista it will only return non-zero if the process is
 654 actually running with elevated privileges.  Returns C<undef>
 655 and prints a warning if an error occurred.  This function always
 656 returns 1 on Win9X.
 657
 658 =item Win32::IsWinNT()
 659
 660 [CORE] Returns non zero if the Win32 subsystem is Windows NT.
 661
 662 =item Win32::IsWin95()
 663
 664 [CORE] Returns non zero if the Win32 subsystem is Windows 95.
 665
 666 =item Win32::LoadLibrary(LIBNAME)
 667
 668 Loads a dynamic link library into memory and returns its module
 669 handle.  This handle can be used with Win32::GetProcAddress() and
 670 Win32::FreeLibrary().  This function is deprecated.  Use the Win32::API
 671 module instead.
 672
 673 =item Win32::LoginName()
 674
 675 [CORE] Returns the username of the owner of the current perl process.
 676 The return value may be a Unicode string.
 677
 678 =item Win32::LookupAccountName(SYSTEM, ACCOUNT, DOMAIN, SID, SIDTYPE)
 679
 680 Looks up ACCOUNT on SYSTEM and returns the domain name the SID and
 681 the SID type.
 682
 683 =item Win32::LookupAccountSID(SYSTEM, SID, ACCOUNT, DOMAIN, SIDTYPE)
 684
 685 Looks up SID on SYSTEM and returns the account name, domain name,
 686 and the SID type.
 687
 688 =item Win32::MsgBox(MESSAGE [, FLAGS [, TITLE]])
 689
 690 Create a dialogbox containing MESSAGE.  FLAGS specifies the
 691 required icon and buttons according to the following table:
 692
 693         0 = OK
 694         1 = OK and Cancel
 695         2 = Abort, Retry, and Ignore
 696         3 = Yes, No and Cancel
 697         4 = Yes and No
 698         5 = Retry and Cancel
 699
 700         MB_ICONSTOP          "X" in a red circle
 701         MB_ICONQUESTION      question mark in a bubble
 702         MB_ICONEXCLAMATION   exclamation mark in a yellow triangle
 703         MB_ICONINFORMATION   "i" in a bubble
 704
 705 TITLE specifies an optional window title.  The default is "Perl".
 706
 707 The function returns the menu id of the selected push button:
 708
 709         0  Error
 710
 711         1  OK
 712         2  Cancel
 713         3  Abort
 714         4  Retry
 715         5  Ignore
 716         6  Yes
 717         7  No
 718
 719 =item Win32::NodeName()
 720
 721 [CORE] Returns the Microsoft Network node-name of the current machine.
 722
 723 =item Win32::OutputDebugString(STRING)
 724
 725 Sends a string to the application or system debugger for display.
 726 The function does nothing if there is no active debugger.
 727
 728 Alternatively one can use the I<Debug Viewer> application to
 729 watch the OutputDebugString() output:
 730
 731 http://www.microsoft.com/technet/sysinternals/utilities/debugview.mspx
 732
 733 =item Win32::RegisterServer(LIBRARYNAME)
 734
 735 Loads the DLL LIBRARYNAME and calls the function DllRegisterServer.
 736
 737 =item Win32::SetChildShowWindow(SHOWWINDOW)
 738
 739 [CORE] Sets the I<ShowMode> of child processes started by system().
 740 By default system() will create a new console window for child
 741 processes if Perl itself is not running from a console.  Calling
 742 SetChildShowWindow(0) will make these new console windows invisible.
 743 Calling SetChildShowWindow() without arguments reverts system() to the
 744 default behavior.  The return value of SetChildShowWindow() is the
 745 previous setting or C<undef>.
 746
 747 The following symbolic constants for SHOWWINDOW are available
 748 (but not exported) from the Win32 module: SW_HIDE, SW_SHOWNORMAL,
 749 SW_SHOWMINIMIZED, SW_SHOWMAXIMIZED and SW_SHOWNOACTIVATE.
 750
 751 =item Win32::SetCwd(NEWDIRECTORY)
 752
 753 [CORE] Sets the current active drive and directory.  This function does not
 754 work with UNC paths, since the functionality required to required for
 755 such a feature is not available under Windows 95.
 756
 757 =item Win32::SetLastError(ERROR)
 758
 759 [CORE] Sets the value of the last error encountered to ERROR.  This is
 760 that value that will be returned by the Win32::GetLastError()
 761 function.
 762
 763 =item Win32::Sleep(TIME)
 764
 765 [CORE] Pauses for TIME milliseconds.  The timeslices are made available
 766 to other processes and threads.
 767
 768 =item Win32::Spawn(COMMAND, ARGS, PID)
 769
 770 [CORE] Spawns a new process using the supplied COMMAND, passing in
 771 arguments in the string ARGS.  The pid of the new process is stored in
 772 PID.  This function is deprecated.  Please use the Win32::Process module
 773 instead.
 774
 775 =item Win32::UnregisterServer(LIBRARYNAME)
 776
 777 Loads the DLL LIBRARYNAME and calls the function
 778 DllUnregisterServer.
 779
 780 =back
 781
 782 =cut