mingw/html/lib/Win32.html

   1 <?xml version="1.0" ?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5 <title>Win32 - Interfaces to some Win32 API Functions</title>
   6 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
   7 <link rev="made" href="mailto:" />
   8 </head>
   9
  10 <body style="background-color: white">
  11 <table border="0" width="100%" cellspacing="0" cellpadding="3">
  12 <tr><td class="block" style="background-color: #cccccc" valign="middle">
  13 <big><strong><span class="block">&nbsp;Win32 - Interfaces to some Win32 API Functions</span></strong></big>
  14 </td></tr>
  15 </table>
  16
  17 <p><a name="__index__"></a></p>
  18 <!-- INDEX BEGIN -->
  19
  20 <ul>
  21
  22         <li><a href="#name">NAME</a></li>
  23         <li><a href="#description">DESCRIPTION</a></li>
  24         <ul>
  25
  26                 <li><a href="#alphabetical_listing_of_win32_functions">Alphabetical Listing of Win32 Functions</a></li>
  27         </ul>
  28
  29 </ul>
  30 <!-- INDEX END -->
  31
  32 <hr />
  33 <p>
  34 </p>
  35 <h1><a name="name">NAME</a></h1>
  36 <p>Win32 - Interfaces to some Win32 API Functions</p>
  37 <p>
  38 </p>
  39 <hr />
  40 <h1><a name="description">DESCRIPTION</a></h1>
  41 <p>Perl on Win32 contains several functions to access Win32 APIs.  Some
  42 are included in Perl itself (on Win32) and some are only available
  43 after explicitly requesting the Win32 module with:</p>
  44 <pre>
  45         use Win32;</pre>
  46 <p>The builtin functions are marked as [CORE] and the other ones
  47 as [EXT] in the following alphabetical listing.</p>
  48 <p>
  49 </p>
  50 <h2><a name="alphabetical_listing_of_win32_functions">Alphabetical Listing of Win32 Functions</a></h2>
  51 <dl>
  52 <dt><strong><a name="item_abortsystemshutdown">Win32::AbortSystemShutdown(MACHINE)</a></strong>
  53
  54 <dd>
  55 <p>[EXT] Aborts a system shutdown (started by the
  56 InitiateSystemShutdown function) on the specified MACHINE.</p>
  57 </dd>
  58 </li>
  59 <dt><strong><a name="item_buildnumber">Win32::BuildNumber()</a></strong>
  60
  61 <dd>
  62 <p>[CORE] Returns the ActivePerl build number.  This function is
  63 only available in the ActivePerl binary distribution.</p>
  64 </dd>
  65 </li>
  66 <dt><strong><a name="item_copyfile">Win32::CopyFile(FROM, TO, OVERWRITE)</a></strong>
  67
  68 <dd>
  69 <p>[CORE] The Win32::CopyFile() function copies an existing file to a new
  70 file.  All file information like creation time and file attributes will
  71 be copied to the new file.  However it will <strong>not</strong> copy the security
  72 information.  If the destination file already exists it will only be
  73 overwritten when the OVERWRITE parameter is true.  But even this will
  74 not overwrite a read-only file; you have to <a href="file://C|\msysgit\mingw\html/pod/perlfunc.html#item_unlink"><code>unlink()</code></a> it first
  75 yourself.</p>
  76 </dd>
  77 </li>
  78 <dt><strong><a name="item_domainname">Win32::DomainName()</a></strong>
  79
  80 <dd>
  81 <p>[CORE] Returns the name of the Microsoft Network domain that the
  82 owner of the current perl process is logged into.  This function does
  83 <strong>not</strong> work on Windows 9x.</p>
  84 </dd>
  85 </li>
  86 <dt><strong><a name="item_expandenvironmentstrings">Win32::ExpandEnvironmentStrings(STRING)</a></strong>
  87
  88 <dd>
  89 <p>[EXT] Takes STRING and replaces all referenced environment variable
  90 names with their defined values.  References to environment variables
  91 take the form <code>%VariableName%</code>.  Case is ignored when looking up the
  92 VariableName in the environment.  If the variable is not found then the
  93 original <code>%VariableName%</code> text is retained.  Has the same effect
  94 as the following:</p>
  95 </dd>
  96 <dd>
  97 <pre>
  98         $string =~ s/%([^%]*)%/$ENV{$1} || &quot;%$1%&quot;/eg</pre>
  99 </dd>
 100 </li>
 101 <dt><strong><a name="item_formatmessage">Win32::FormatMessage(ERRORCODE)</a></strong>
 102
 103 <dd>
 104 <p>[CORE] Converts the supplied Win32 error number (e.g. returned by
 105 Win32::GetLastError()) to a descriptive string.  Analogous to the
 106 <code>perror()</code> standard-C library function.  Note that <a href="file://C|\msysgit\mingw\html/pod/perlvar.html#item___e"><code>$^E</code></a> used
 107 in a string context has much the same effect.</p>
 108 </dd>
 109 <dd>
 110 <pre>
 111         C:\&gt; perl -e &quot;$^E = 26; print $^E;&quot;
 112         The specified disk or diskette cannot be accessed</pre>
 113 </dd>
 114 </li>
 115 <dt><strong><a name="item_fstype">Win32::FsType()</a></strong>
 116
 117 <dd>
 118 <p>[CORE] Returns the name of the filesystem of the currently active
 119 drive (like 'FAT' or 'NTFS').  In list context it returns three values:
 120 (FSTYPE, FLAGS, MAXCOMPLEN).  FSTYPE is the filesystem type as
 121 before.  FLAGS is a combination of values of the following table:</p>
 122 </dd>
 123 <dd>
 124 <pre>
 125         0x00000001  supports case-sensitive filenames
 126         0x00000002  preserves the case of filenames
 127         0x00000004  supports Unicode in filenames
 128         0x00000008  preserves and enforces ACLs
 129         0x00000010  supports file-based compression
 130         0x00000020  supports disk quotas
 131         0x00000040  supports sparse files
 132         0x00000080  supports reparse points
 133         0x00000100  supports remote storage
 134         0x00008000  is a compressed volume (e.g. DoubleSpace)
 135         0x00010000  supports object identifiers
 136         0x00020000  supports the Encrypted File System (EFS)</pre>
 137 </dd>
 138 <dd>
 139 <p>MAXCOMPLEN is the maximum length of a filename component (the part
 140 between two backslashes) on this file system.</p>
 141 </dd>
 142 </li>
 143 <dt><strong><a name="item_freelibrary">Win32::FreeLibrary(HANDLE)</a></strong>
 144
 145 <dd>
 146 <p>[EXT] Unloads a previously loaded dynamic-link library.  The HANDLE is
 147 no longer valid after this call.  See <a href="file://C|\msysgit\mingw\html/Win32/LoadLibrary(LIBNAME).html">LoadLibrary</a>
 148 for information on dynamically loading a library.</p>
 149 </dd>
 150 </li>
 151 <dt><strong><a name="item_getarchname">Win32::GetArchName()</a></strong>
 152
 153 <dd>
 154 <p>[EXT] Use of this function is deprecated.  It is equivalent with
 155 $ENV{PROCESSOR_ARCHITECTURE}.  This might not work on Win9X.</p>
 156 </dd>
 157 </li>
 158 <dt><strong><a name="item_getchipname">Win32::GetChipName()</a></strong>
 159
 160 <dd>
 161 <p>[EXT] Returns the processor type: 386, 486 or 586 for Intel processors,
 162 21064 for the Alpha chip.</p>
 163 </dd>
 164 </li>
 165 <dt><strong><a name="item_getcwd">Win32::GetCwd()</a></strong>
 166
 167 <dd>
 168 <p>[CORE] Returns the current active drive and directory.  This function
 169 does not return a UNC path, since the functionality required for such
 170 a feature is not available under Windows 95.</p>
 171 </dd>
 172 </li>
 173 <dt><strong><a name="item_getfileversion">Win32::GetFileVersion(FILENAME)</a></strong>
 174
 175 <dd>
 176 <p>[EXT] Returns the file version number from the VERSIONINFO resource of
 177 the executable file or DLL.  This is a tuple of four 16 bit numbers.
 178 In list context these four numbers will be returned.  In scalar context
 179 they are concatenated into a string, separated by dots.</p>
 180 </dd>
 181 </li>
 182 <dt><strong><a name="item_getfolderpath">Win32::GetFolderPath(FOLDER [, CREATE])</a></strong>
 183
 184 <dd>
 185 <p>[EXT] Returns the full pathname of one of the Windows special folders.
 186 The folder will be created if it doesn't exist and the optional CREATE
 187 argument is true.  The following FOLDER constants are defined by the
 188 Win32 module, but only exported on demand:</p>
 189 </dd>
 190 <dd>
 191 <pre>
 192         CSIDL_ADMINTOOLS
 193         CSIDL_APPDATA
 194         CSIDL_CDBURN_AREA
 195         CSIDL_COMMON_ADMINTOOLS
 196         CSIDL_COMMON_APPDATA
 197         CSIDL_COMMON_DESKTOPDIRECTORY
 198         CSIDL_COMMON_DOCUMENTS
 199         CSIDL_COMMON_FAVORITES
 200         CSIDL_COMMON_MUSIC
 201         CSIDL_COMMON_PICTURES
 202         CSIDL_COMMON_PROGRAMS
 203         CSIDL_COMMON_STARTMENU
 204         CSIDL_COMMON_STARTUP
 205         CSIDL_COMMON_TEMPLATES
 206         CSIDL_COMMON_VIDEO
 207         CSIDL_COOKIES
 208         CSIDL_DESKTOP
 209         CSIDL_DESKTOPDIRECTORY
 210         CSIDL_FAVORITES
 211         CSIDL_FONTS
 212         CSIDL_HISTORY
 213         CSIDL_INTERNET_CACHE
 214         CSIDL_LOCAL_APPDATA
 215         CSIDL_MYMUSIC
 216         CSIDL_MYPICTURES
 217         CSIDL_MYVIDEO
 218         CSIDL_NETHOOD
 219         CSIDL_PERSONAL
 220         CSIDL_PRINTHOOD
 221         CSIDL_PROFILE
 222         CSIDL_PROGRAMS
 223         CSIDL_PROGRAM_FILES
 224         CSIDL_PROGRAM_FILES_COMMON
 225         CSIDL_RECENT
 226         CSIDL_RESOURCES
 227         CSIDL_RESOURCES_LOCALIZED
 228         CSIDL_SENDTO
 229         CSIDL_STARTMENU
 230         CSIDL_STARTUP
 231         CSIDL_SYSTEM
 232         CSIDL_TEMPLATES
 233         CSIDL_WINDOWS</pre>
 234 </dd>
 235 <dd>
 236 <p>Note that not all folders are defined on all versions of Windows.</p>
 237 </dd>
 238 <dd>
 239 <p>Please refer to the MSDN documentation of the CSIDL constants,
 240 currently available at:</p>
 241 </dd>
 242 <dd>
 243 <p><a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/shellcc/platform/shell/reference/enums/csidl.asp">http://msdn.microsoft.com/library/default.asp?url=/library/en-us/shellcc/platform/shell/reference/enums/csidl.asp</a></p>
 244 </dd>
 245 </li>
 246 <dt><strong><a name="item_getfullpathname">Win32::GetFullPathName(FILENAME)</a></strong>
 247
 248 <dd>
 249 <p>[CORE] GetFullPathName combines the FILENAME with the current drive
 250 and directory name and returns a fully qualified (aka, absolute)
 251 path name.  In list context it returns two elements: (PATH, FILE) where
 252 PATH is the complete pathname component (including trailing backslash)
 253 and FILE is just the filename part.  Note that no attempt is made to
 254 convert 8.3 components in the supplied FILENAME to longnames or
 255 vice-versa.  Compare with Win32::GetShortPathName and
 256 Win32::GetLongPathName.</p>
 257 </dd>
 258 </li>
 259 <dt><strong><a name="item_getlasterror">Win32::GetLastError()</a></strong>
 260
 261 <dd>
 262 <p>[CORE] Returns the last error value generated by a call to a Win32 API
 263 function.  Note that <a href="file://C|\msysgit\mingw\html/pod/perlvar.html#item___e"><code>$^E</code></a> used in a numeric context amounts to the
 264 same value.</p>
 265 </dd>
 266 </li>
 267 <dt><strong><a name="item_getlongpathname">Win32::GetLongPathName(PATHNAME)</a></strong>
 268
 269 <dd>
 270 <p>[CORE] Returns a representation of PATHNAME composed of longname
 271 components (if any).  The result may not necessarily be longer
 272 than PATHNAME.  No attempt is made to convert PATHNAME to the
 273 absolute path.  Compare with Win32::GetShortPathName and
 274 Win32::GetFullPathName.</p>
 275 </dd>
 276 </li>
 277 <dt><strong><a name="item_getnextavaildrive">Win32::GetNextAvailDrive()</a></strong>
 278
 279 <dd>
 280 <p>[CORE] Returns a string in the form of ``&lt;d&gt;:'' where &lt;d&gt; is the first
 281 available drive letter.</p>
 282 </dd>
 283 </li>
 284 <dt><strong><a name="item_getosversion">Win32::GetOSVersion()</a></strong>
 285
 286 <dd>
 287 <p>[CORE] Returns the list (STRING, MAJOR, MINOR, BUILD, ID), where the
 288 elements are, respectively: An arbitrary descriptive string, the major
 289 version number of the operating system, the minor version number, the
 290 build number, and a digit indicating the actual operating system.
 291 For the ID, the values are 0 for Win32s, 1 for Windows 9X/Me and 2 for
 292 Windows NT/2000/XP/2003.  In scalar context it returns just the ID.</p>
 293 </dd>
 294 <dd>
 295 <p>Currently known values for ID MAJOR and MINOR are as follows:</p>
 296 </dd>
 297 <dd>
 298 <pre>
 299     OS                    ID    MAJOR   MINOR
 300     Win32s                 0      -       -
 301     Windows 95             1      4       0
 302     Windows 98             1      4      10
 303     Windows Me             1      4      90
 304     Windows NT 3.51        2      3      51
 305     Windows NT 4           2      4       0
 306     Windows 2000           2      5       0
 307     Windows XP             2      5       1
 308     Windows Server 2003    2      5       2
 309     Windows Vista          2      6       0</pre>
 310 </dd>
 311 <dd>
 312 <p>On Windows NT 4 SP6 and later this function returns the following
 313 additional values: SPMAJOR, SPMINOR, SUITEMASK, PRODUCTTYPE.</p>
 314 </dd>
 315 <dd>
 316 <p>SPMAJOR and SPMINOR are are the version numbers of the latest
 317 installed service pack.</p>
 318 </dd>
 319 <dd>
 320 <p>SUITEMASK is a bitfield identifying the product suites available on
 321 the system.  Known bits are:</p>
 322 </dd>
 323 <dd>
 324 <pre>
 325     VER_SUITE_SMALLBUSINESS             0x00000001
 326     VER_SUITE_ENTERPRISE                0x00000002
 327     VER_SUITE_BACKOFFICE                0x00000004
 328     VER_SUITE_COMMUNICATIONS            0x00000008
 329     VER_SUITE_TERMINAL                  0x00000010
 330     VER_SUITE_SMALLBUSINESS_RESTRICTED  0x00000020
 331     VER_SUITE_EMBEDDEDNT                0x00000040
 332     VER_SUITE_DATACENTER                0x00000080
 333     VER_SUITE_SINGLEUSERTS              0x00000100
 334     VER_SUITE_PERSONAL                  0x00000200
 335     VER_SUITE_BLADE                     0x00000400
 336     VER_SUITE_EMBEDDED_RESTRICTED       0x00000800
 337     VER_SUITE_SECURITY_APPLIANCE        0x00001000</pre>
 338 </dd>
 339 <dd>
 340 <p>The VER_SUITE_xxx names are listed here to crossreference the Microsoft
 341 documentation.  The Win32 module does not provide symbolic names for these
 342 constants.</p>
 343 </dd>
 344 <dd>
 345 <p>PRODUCTTYPE provides additional information about the system.  It should
 346 be one of the following integer values:</p>
 347 </dd>
 348 <dd>
 349 <pre>
 350     1 - Workstation (NT 4, 2000 Pro, XP Home, XP Pro)
 351     2 - Domaincontroller
 352     3 - Server</pre>
 353 </dd>
 354 </li>
 355 <dt><strong><a name="item_getosname">Win32::GetOSName()</a></strong>
 356
 357 <dd>
 358 <p>[EXT] In scalar context returns the name of the Win32 operating system
 359 being used.  In list context returns a two element list of the OS name
 360 and whatever edition information is known about the particular build
 361 (for Win9X boxes) and whatever service packs have been installed.
 362 The latter is roughly equivalent to the first item returned by
 363 <a href="#item_getosversion"><code>GetOSVersion()</code></a> in list context.</p>
 364 </dd>
 365 <dd>
 366 <p>Currently the possible values for the OS name are</p>
 367 </dd>
 368 <dd>
 369 <pre>
 370  Win32s Win95 Win98 WinMe WinNT3.51 WinNT4 Win2000 WinXP/.Net Win2003</pre>
 371 </dd>
 372 <dd>
 373 <p>This routine is just a simple interface into GetOSVersion().  More
 374 specific or demanding situations should use that instead.  Another
 375 option would be to use POSIX::uname(), however the latter appears to
 376 report only the OS family name and not the specific OS.  In scalar
 377 context it returns just the ID.</p>
 378 </dd>
 379 <dd>
 380 <p>The name ``WinXP/.Net'' is used for historical reasons only, to maintain
 381 backwards compatibility of the Win32 module.  Windows .NET Server has
 382 been renamed as Windows 2003 Server before final release and uses a
 383 different major/minor version number than Windows XP.</p>
 384 </dd>
 385 </li>
 386 <dt><strong><a name="item_getshortpathname">Win32::GetShortPathName(PATHNAME)</a></strong>
 387
 388 <dd>
 389 <p>[CORE] Returns a representation of PATHNAME that is composed of short
 390 (8.3) path components where available.  For path components where the
 391 file system has not generated the short form the returned path will
 392 use the long form, so this function might still for instance return a
 393 path containing spaces.  Compare with Win32::GetFullPathName and
 394 Win32::GetLongPathName.</p>
 395 </dd>
 396 </li>
 397 <dt><strong><a name="item_getprocaddress">Win32::GetProcAddress(INSTANCE, PROCNAME)</a></strong>
 398
 399 <dd>
 400 <p>[EXT] Returns the address of a function inside a loaded library.  The
 401 information about what you can do with this address has been lost in
 402 the mist of time.  Use the Win32::API module instead of this deprecated
 403 function.</p>
 404 </dd>
 405 </li>
 406 <dt><strong><a name="item_gettickcount">Win32::GetTickCount()</a></strong>
 407
 408 <dd>
 409 <p>[CORE] Returns the number of milliseconds elapsed since the last
 410 system boot.  Resolution is limited to system timer ticks (about 10ms
 411 on WinNT and 55ms on Win9X).</p>
 412 </dd>
 413 </li>
 414 <dt><strong><a name="item_guidgen">Win32::GuidGen()</a></strong>
 415
 416 <dd>
 417 <p>[EXT] Creates a globally unique 128 bit integer that can be used as a
 418 persistent identifier in a distributed setting. To a very high degree
 419 of certainty this function returns a unique value. No other
 420 invocation, on the same or any other system (networked or not), should
 421 return the same value.</p>
 422 </dd>
 423 <dd>
 424 <p>The return value is formatted according to OLE conventions, as groups
 425 of hex digits with surrounding braces.  For example:</p>
 426 </dd>
 427 <dd>
 428 <pre>
 429     {09531CF1-D0C7-4860-840C-1C8C8735E2AD}
 430
 431 =item Win32::InitiateSystemShutdown</pre>
 432 </dd>
 433 <dd>
 434 <p>(MACHINE, MESSAGE, TIMEOUT, FORCECLOSE, REBOOT)</p>
 435 </dd>
 436 <dd>
 437 <p>[EXT] Shutsdown the specified MACHINE, notifying users with the
 438 supplied MESSAGE, within the specified TIMEOUT interval.  Forces
 439 closing of all documents without prompting the user if FORCECLOSE is
 440 true, and reboots the machine if REBOOT is true.  This function works
 441 only on WinNT.</p>
 442 </dd>
 443 </li>
 444 <dt><strong><a name="item_isadminuser">Win32::IsAdminUser()</a></strong>
 445
 446 <dd>
 447 <p>[EXT] Returns non zero if the account in whose security context the
 448 current process/thread is running belongs to the local group of
 449 Administrators in the built-in system domain; returns 0 if not.
 450 Returns the undefined value and prints a warning if an error occurred.
 451 This function always returns 1 on Win9X.</p>
 452 </dd>
 453 </li>
 454 <dt><strong><a name="item_iswinnt">Win32::IsWinNT()</a></strong>
 455
 456 <dd>
 457 <p>[CORE] Returns non zero if the Win32 subsystem is Windows NT.</p>
 458 </dd>
 459 </li>
 460 <dt><strong><a name="item_iswin95">Win32::IsWin95()</a></strong>
 461
 462 <dd>
 463 <p>[CORE] Returns non zero if the Win32 subsystem is Windows 95.</p>
 464 </dd>
 465 </li>
 466 <dt><strong><a name="item_loadlibrary">Win32::LoadLibrary(LIBNAME)</a></strong>
 467
 468 <dd>
 469 <p>[EXT] Loads a dynamic link library into memory and returns its module
 470 handle.  This handle can be used with Win32::GetProcAddress and
 471 Win32::FreeLibrary.  This function is deprecated.  Use the Win32::API
 472 module instead.</p>
 473 </dd>
 474 </li>
 475 <dt><strong><a name="item_loginname">Win32::LoginName()</a></strong>
 476
 477 <dd>
 478 <p>[CORE] Returns the username of the owner of the current perl process.</p>
 479 </dd>
 480 </li>
 481 <dt><strong><a name="item_lookupaccountname">Win32::LookupAccountName(SYSTEM, ACCOUNT, DOMAIN, SID, SIDTYPE)</a></strong>
 482
 483 <dd>
 484 <p>[EXT] Looks up ACCOUNT on SYSTEM and returns the domain name the SID and
 485 the SID type.</p>
 486 </dd>
 487 </li>
 488 <dt><strong><a name="item_lookupaccountsid">Win32::LookupAccountSID(SYSTEM, SID, ACCOUNT, DOMAIN, SIDTYPE)</a></strong>
 489
 490 <dd>
 491 <p>[EXT] Looks up SID on SYSTEM and returns the account name, domain name,
 492 and the SID type.</p>
 493 </dd>
 494 </li>
 495 <dt><strong><a name="item_msgbox">Win32::MsgBox(MESSAGE [, FLAGS [, TITLE]])</a></strong>
 496
 497 <dd>
 498 <p>[EXT] Create a dialogbox containing MESSAGE.  FLAGS specifies the
 499 required icon and buttons according to the following table:</p>
 500 </dd>
 501 <dd>
 502 <pre>
 503         0 = OK
 504         1 = OK and Cancel
 505         2 = Abort, Retry, and Ignore
 506         3 = Yes, No and Cancel
 507         4 = Yes and No
 508         5 = Retry and Cancel</pre>
 509 </dd>
 510 <dd>
 511 <pre>
 512         MB_ICONSTOP          &quot;X&quot; in a red circle
 513         MB_ICONQUESTION      question mark in a bubble
 514         MB_ICONEXCLAMATION   exclamation mark in a yellow triangle
 515         MB_ICONINFORMATION   &quot;i&quot; in a bubble</pre>
 516 </dd>
 517 <dd>
 518 <p>TITLE specifies an optional window title.  The default is ``Perl''.</p>
 519 </dd>
 520 <dd>
 521 <p>The function returns the menu id of the selected push button:</p>
 522 </dd>
 523 <dd>
 524 <pre>
 525         0  Error</pre>
 526 </dd>
 527 <dd>
 528 <pre>
 529         1  OK
 530         2  Cancel
 531         3  Abort
 532         4  Retry
 533         5  Ignore
 534         6  Yes
 535         7  No</pre>
 536 </dd>
 537 </li>
 538 <dt><strong><a name="item_nodename">Win32::NodeName()</a></strong>
 539
 540 <dd>
 541 <p>[CORE] Returns the Microsoft Network node-name of the current machine.</p>
 542 </dd>
 543 </li>
 544 <dt><strong><a name="item_registerserver">Win32::RegisterServer(LIBRARYNAME)</a></strong>
 545
 546 <dd>
 547 <p>[EXT] Loads the DLL LIBRARYNAME and calls the function DllRegisterServer.</p>
 548 </dd>
 549 </li>
 550 <dt><strong><a name="item_setchildshowwindow">Win32::SetChildShowWindow(SHOWWINDOW)</a></strong>
 551
 552 <dd>
 553 <p>[CORE] Sets the <em>ShowMode</em> of child processes started by system().
 554 By default <a href="file://C|\msysgit\mingw\html/pod/perlfunc.html#item_system"><code>system()</code></a> will create a new console window for child
 555 processes if Perl itself is not running from a console.  Calling
 556 <a href="#item_setchildshowwindow"><code>SetChildShowWindow(0)</code></a> will make these new console windows invisible.
 557 Calling <a href="#item_setchildshowwindow"><code>SetChildShowWindow()</code></a> without arguments reverts <a href="file://C|\msysgit\mingw\html/pod/perlfunc.html#item_system"><code>system()</code></a> to the
 558 default behavior.  The return value of <a href="#item_setchildshowwindow"><code>SetChildShowWindow()</code></a> is the
 559 previous setting or <a href="file://C|\msysgit\mingw\html/pod/perlfunc.html#item_undef"><code>undef</code></a>.</p>
 560 </dd>
 561 <dd>
 562 <p>[EXT] The following symbolic constants for SHOWWINDOW are available
 563 (but not exported) from the Win32 module: SW_HIDE, SW_SHOWNORMAL,
 564 SW_SHOWMINIMIZED, SW_SHOWMAXIMIZED and SW_SHOWNOACTIVATE.</p>
 565 </dd>
 566 </li>
 567 <dt><strong><a name="item_setcwd">Win32::SetCwd(NEWDIRECTORY)</a></strong>
 568
 569 <dd>
 570 <p>[CORE] Sets the current active drive and directory.  This function does not
 571 work with UNC paths, since the functionality required to required for
 572 such a feature is not available under Windows 95.</p>
 573 </dd>
 574 </li>
 575 <dt><strong><a name="item_setlasterror">Win32::SetLastError(ERROR)</a></strong>
 576
 577 <dd>
 578 <p>[CORE] Sets the value of the last error encountered to ERROR.  This is
 579 that value that will be returned by the Win32::GetLastError()
 580 function.</p>
 581 </dd>
 582 </li>
 583 <dt><strong><a name="item_sleep">Win32::Sleep(TIME)</a></strong>
 584
 585 <dd>
 586 <p>[CORE] Pauses for TIME milliseconds.  The timeslices are made available
 587 to other processes and threads.</p>
 588 </dd>
 589 </li>
 590 <dt><strong><a name="item_spawn">Win32::Spawn(COMMAND, ARGS, PID)</a></strong>
 591
 592 <dd>
 593 <p>[CORE] Spawns a new process using the supplied COMMAND, passing in
 594 arguments in the string ARGS.  The pid of the new process is stored in
 595 PID.  This function is deprecated.  Please use the Win32::Process module
 596 instead.</p>
 597 </dd>
 598 </li>
 599 <dt><strong><a name="item_unregisterserver">Win32::UnregisterServer(LIBRARYNAME)</a></strong>
 600
 601 <dd>
 602 <p>[EXT] Loads the DLL LIBRARYNAME and calls the function
 603 DllUnregisterServer.</p>
 604 </dd>
 605 </li>
 606 </dl>
 607 <table border="0" width="100%" cellspacing="0" cellpadding="3">
 608 <tr><td class="block" style="background-color: #cccccc" valign="middle">
 609 <big><strong><span class="block">&nbsp;Win32 - Interfaces to some Win32 API Functions</span></strong></big>
 610 </td></tr>
 611 </table>
 612
 613 </body>
 614
 615 </html>