This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Doc patches: assorted minor nits
[perl5.git] / lib / Win32.pod
CommitLineData
1674ad2b
JD
1=head1 NAME
2
3Win32 - Interfaces to some Win32 API Functions
4
5=head1 DESCRIPTION
6
7Perl on Win32 contains several functions to access Win32 APIs. Some
8are included in Perl itself (on Win32) and some are only available
9after explicitly requesting the Win32 module with:
10
11 use Win32;
12
13The builtin functions are marked as [CORE] and the other ones
14as [EXT] in the following alphabetical listing. The C<Win32> module
15is not part of the Perl source distribution; it is distributed in
16the libwin32 bundle of Win32::* modules on CPAN. The module is
17already preinstalled in binary distributions like ActivePerl.
18
19=head2 Alphabetical Listing of Win32 Functions
20
21=over
22
23=item Win32::AbortSystemShutdown(MACHINE)
24
25[EXT] Aborts a system shutdown (started by the
26InitiateSystemShutdown function) on the specified MACHINE.
27
28=item Win32::BuildNumber()
29
30[CORE] Returns the ActivePerl build number. This function is
31only available in the ActivePerl binary distribution.
32
33=item Win32::CopyFile(FROM, TO, OVERWRITE)
34
625a29bd
GS
35[CORE] The Win32::CopyFile() function copies an existing file to a new
36file. All file information like creation time and file attributes will
37be copied to the new file. However it will B<not> copy the security
38information. If the destination file already exists it will only be
39overwritten when the OVERWRITE parameter is true. But even this will
40not overwrite a read-only file; you have to unlink() it first
41yourself.
1674ad2b
JD
42
43=item Win32::DomainName()
44
45[CORE] Returns the name of the Microsoft Network domain that the
da147683
JD
46owner of the current perl process is logged into. This function does
47B<not> work on Windows 9x.
1674ad2b
JD
48
49=item Win32::ExpandEnvironmentStrings(STRING)
50
51[EXT] Takes STRING and replaces all referenced environment variable
52names with their defined values. References to environment variables
53take the form C<%VariableName%>. Case is ignored when looking up the
54VariableName in the environment. If the variable is not found then the
55original C<%VariableName%> text is retained. Has the same effect
56as the following:
57
58 $string =~ s/%([^%]*)%/$ENV{$1} || "%$1%"/eg
59
60=item Win32::FormatMessage(ERRORCODE)
61
62[CORE] Converts the supplied Win32 error number (e.g. returned by
63Win32::GetLastError()) to a descriptive string. Analogous to the
64perror() standard-C library function. Note that C<$^E> used
65in a string context has much the same effect.
66
67 C:\> perl -e "$^E = 26; print $^E;"
68 The specified disk or diskette cannot be accessed
69
70=item Win32::FsType()
71
72[CORE] Returns the name of the filesystem of the currently active
73drive (like 'FAT' or 'NTFS'). In list context it returns three values:
74(FSTYPE, FLAGS, MAXCOMPLEN). FSTYPE is the filesystem type as
75before. FLAGS is a combination of values of the following table:
76
77 0x00000001 supports case-sensitive filenames
78 0x00000002 preserves the case of filenames
79 0x00000004 supports Unicode in filenames
80 0x00000008 preserves and enforces ACLs
81 0x00000010 supports file-based compression
82 0x00000020 supports disk quotas
83 0x00000040 supports sparse files
84 0x00000080 supports reparse points
85 0x00000100 supports remote storage
86 0x00008000 is a compressed volume (e.g. DoubleSpace)
87 0x00010000 supports object identifiers
88 0x00020000 supports the Encrypted File System (EFS)
89
90MAXCOMPLEN is the maximum length of a filename component (the part
91between two backslashes) on this file system.
92
93=item Win32::FreeLibrary(HANDLE)
94
95[EXT] Unloads a previously loaded dynamic-link library. The HANDLE is
4a4eefd0
GS
96no longer valid after this call. See L<LoadLibrary|Win32::LoadLibrary(LIBNAME)>
97for information on dynamically loading a library.
1674ad2b
JD
98
99=item Win32::GetArchName()
100
101[EXT] Use of this function is deprecated. It is equivalent with
102$ENV{PROCESSOR_ARCHITECTURE}. This might not work on Win9X.
103
104=item Win32::GetChipName()
105
106[EXT] Returns the processor type: 386, 486 or 586 for Intel processors,
10721064 for the Alpha chip.
108
109=item Win32::GetCwd()
110
111[CORE] Returns the current active drive and directory. This function
112does not return a UNC path, since the functionality required for such
113a feature is not available under Windows 95.
114
115=item Win32::GetFullPathName(FILENAME)
116
117[CORE] GetFullPathName combines the FILENAME with the current drive
118and directory name and returns a fully qualified (aka, absolute)
119path name. In list context it returns two elements: (PATH, FILE) where
120PATH is the complete pathname component (including trailing backslash)
121and FILE is just the filename part. Note that no attempt is made to
122convert 8.3 components in the supplied FILENAME to longnames or
123vice-versa. Compare with Win32::GetShortPathName and
124Win32::GetLongPathName.
125
87275199 126This function has been added for Perl 5.6.
1674ad2b
JD
127
128=item Win32::GetLastError()
129
130[CORE] Returns the last error value generated by a call to a Win32 API
131function. Note that C<$^E> used in a numeric context amounts to the
132same value.
133
134=item Win32::GetLongPathName(PATHNAME)
135
4375e838 136[CORE] Returns a representation of PATHNAME composed of longname
da2094fd 137components (if any). The result may not necessarily be longer
1674ad2b
JD
138than PATHNAME. No attempt is made to convert PATHNAME to the
139absolute path. Compare with Win32::GetShortPathName and
140Win32::GetFullPathName.
141
87275199 142This function has been added for Perl 5.6.
1674ad2b
JD
143
144=item Win32::GetNextAvailDrive()
145
146[CORE] Returns a string in the form of "<d>:" where <d> is the first
147available drive letter.
148
149=item Win32::GetOSVersion()
150
151[CORE] Returns the array (STRING, MAJOR, MINOR, BUILD, ID), where
152the elements are, respectively: An arbitrary descriptive string, the
153major version number of the operating system, the minor version
154number, the build number, and a digit indicating the actual operating
155system. For ID, the values are 0 for Win32s, 1 for Windows 9X and 2
156for Windows NT. In scalar context it returns just the ID.
157
158=item Win32::GetShortPathName(PATHNAME)
159
da2094fd 160[CORE] Returns a representation of PATHNAME composed only of
1674ad2b
JD
161short (8.3) path components. The result may not necessarily be
162shorter than PATHNAME. Compare with Win32::GetFullPathName and
163Win32::GetLongPathName.
164
165=item Win32::GetProcAddress(INSTANCE, PROCNAME)
166
167[EXT] Returns the address of a function inside a loaded library. The
168information about what you can do with this address has been lost in
169the mist of time. Use the Win32::API module instead of this deprecated
170function.
171
172=item Win32::GetTickCount()
173
174[CORE] Returns the number of milliseconds elapsed since the last
175system boot. Resolution is limited to system timer ticks (about 10ms
176on WinNT and 55ms on Win9X).
177
cb49b31f 178=item Win32::InitiateSystemShutdown
551e1d92 179
cb49b31f 180(MACHINE, MESSAGE, TIMEOUT, FORCECLOSE, REBOOT)
1674ad2b
JD
181
182[EXT] Shutsdown the specified MACHINE, notifying users with the
183supplied MESSAGE, within the specified TIMEOUT interval. Forces
184closing of all documents without prompting the user if FORCECLOSE is
185true, and reboots the machine if REBOOT is true. This function works
186only on WinNT.
187
188=item Win32::IsWinNT()
189
190[CORE] Returns non zero if the Win32 subsystem is Windows NT.
191
192=item Win32::IsWin95()
193
194[CORE] Returns non zero if the Win32 subsystem is Windows 95.
195
196=item Win32::LoadLibrary(LIBNAME)
197
198[EXT] Loads a dynamic link library into memory and returns its module
199handle. This handle can be used with Win32::GetProcAddress and
200Win32::FreeLibrary. This function is deprecated. Use the Win32::API
201module instead.
202
203=item Win32::LoginName()
204
205[CORE] Returns the username of the owner of the current perl process.
206
207=item Win32::LookupAccountName(SYSTEM, ACCOUNT, DOMAIN, SID, SIDTYPE)
208
209[EXT] Looks up ACCOUNT on SYSTEM and returns the domain name the SID and
210the SID type.
211
212=item Win32::LookupAccountSID(SYSTEM, SID, ACCOUNT, DOMAIN, SIDTYPE)
213
625a29bd 214[EXT] Looks up SID on SYSTEM and returns the account name, domain name,
1674ad2b
JD
215and the SID type.
216
217=item Win32::MsgBox(MESSAGE [, FLAGS [, TITLE]])
218
219[EXT] Create a dialogbox containing MESSAGE. FLAGS specifies the
220required icon and buttons according to the following table:
221
222 0 = OK
223 1 = OK and Cancel
224 2 = Abort, Retry, and Ignore
225 3 = Yes, No and Cancel
226 4 = Yes and No
227 5 = Retry and Cancel
228
229 MB_ICONSTOP "X" in a red circle
230 MB_ICONQUESTION question mark in a bubble
231 MB_ICONEXCLAMATION exclamation mark in a yellow triangle
232 MB_ICONINFORMATION "i" in a bubble
233
234TITLE specifies an optional window title. The default is "Perl".
235
236The function returns the menu id of the selected push button:
237
238 0 Error
239
240 1 OK
241 2 Cancel
242 3 Abort
243 4 Retry
244 5 Ignore
245 6 Yes
246 7 No
247
248=item Win32::NodeName()
249
250[CORE] Returns the Microsoft Network node-name of the current machine.
251
252=item Win32::RegisterServer(LIBRARYNAME)
253
254[EXT] Loads the DLL LIBRARYNAME and calls the function DllRegisterServer.
255
02637f4c
JD
256=item Win32::SetChildShowWindow(SHOWWINDOW)
257
258[CORE] Sets the I<ShowMode> of child processes started by system().
259By default system() will create a new console window for child
260processes if Perl itself is not running from a console. Calling
261SetChildShowWindow(0) will make these new console windows invisible.
262Calling SetChildShowWindow() without arguments reverts system() to the
263default behavior. The return value of SetChildShowWindow() is the
264previous setting or C<undef>.
265
266[EXT] The following symbolic constants for SHOWWINDOW are available
267(but not exported) from the Win32 module: SW_HIDE, SW_SHOWNORMAL,
268SW_SHOWMINIMIZED, SW_SHOWMAXIMIZED and SW_SHOWNOACTIVATE.
269
1674ad2b
JD
270=item Win32::SetCwd(NEWDIRECTORY)
271
272[CORE] Sets the current active drive and directory. This function does not
273work with UNC paths, since the functionality required to required for
274such a feature is not available under Windows 95.
275
276=item Win32::SetLastError(ERROR)
277
278[CORE] Sets the value of the last error encountered to ERROR. This is
279that value that will be returned by the Win32::GetLastError()
87275199 280function. This functions has been added for Perl 5.6.
1674ad2b
JD
281
282=item Win32::Sleep(TIME)
283
284[CORE] Pauses for TIME milliseconds. The timeslices are made available
285to other processes and threads.
286
287=item Win32::Spawn(COMMAND, ARGS, PID)
288
289[CORE] Spawns a new process using the supplied COMMAND, passing in
290arguments in the string ARGS. The pid of the new process is stored in
291PID. This function is deprecated. Please use the Win32::Process module
292instead.
293
294=item Win32::UnregisterServer(LIBRARYNAME)
295
296[EXT] Loads the DLL LIBRARYNAME and calls the function
297DllUnregisterServer.
298
299=back
300
301=cut