.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Padre::Util::Win32 3pm"
.TH Padre::Util::Win32 3pm "2014-09-11" "perl v5.20.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Padre::Util::Win32 \- Padre Win32 API Functions
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \f(CW\*(C`Padre::Util::Win32\*(C'\fR package provides an \s-1XS\s0 wrapper for Win32
\&\s-1API\s0 functions
.PP
All functions are exportable and documented for maintenance purposes,
but except for in the Padre core distribution you are discouraged in the
strongest possible terms from using these functions, as they may be
moved, removed or changed at any time without notice.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.ie n .SS """GetLongPathName"""
.el .SS "\f(CWGetLongPathName\fP"
.IX Subsection "GetLongPathName"
.Vb 1
\&  Padre::Util::Win32::GetLongPathName($path);
.Ve
.PP
Converts the specified path \f(CW$path\fR to its long form.
Returns \f(CW\*(C`undef\*(C'\fR for failure, or the long form of the specified path
.ie n .SS """Recycle"""
.el .SS "\f(CWRecycle\fP"
.IX Subsection "Recycle"
.Vb 1
\&  Padre::Util::Win32::Recycle($file_to_recycle);
.Ve
.PP
Move \f(CW$file_to_recycle\fR to recycle bin
Returns \f(CW\*(C`undef\*(C'\fR (failed), zero (aborted) or one (success)
.ie n .SS """AllowSetForegroundWindow"""
.el .SS "\f(CWAllowSetForegroundWindow\fP"
.IX Subsection "AllowSetForegroundWindow"
.Vb 1
\&  Padre::Util::Win32::AllowSetForegroundWindow($pid);
.Ve
.PP
Enables the specified process \f(CW$pid\fR to set the foreground window
via \f(CW\*(C`SetForegroundWindow\*(C'\fR
.PP
<http://msdn.microsoft.com/en\-us/library/ms633539(\s-1VS.85\s0).aspx>
.ie n .SS """ExecuteProcessAndWait"""
.el .SS "\f(CWExecuteProcessAndWait\fP"
.IX Subsection "ExecuteProcessAndWait"
.Vb 6
\&  Padre::Util::Win32::ExecuteProcessAndWait(
\&      directory  => $directory,
\&      file       => $file,
\&      parameters => $parameters,
\&      show       => $show,
\&  )
.Ve
.PP
Execute a background process named "\f(CW$file\fR \f(CW$parameters\fR" with the current
directory set to \f(CW$directory\fR and wait for it to end. If you set \f(CW$show\fR to 0,
then you have an invisible command line window on win32!
.ie n .SS """GetCurrentProcessMemorySize"""
.el .SS "\f(CWGetCurrentProcessMemorySize\fP"
.IX Subsection "GetCurrentProcessMemorySize"
.Vb 1
\&  Padre::Util::Win32::GetCurrentProcessMemorySize;
.Ve
.PP
Returns the current process memory size in bytes
.ie n .SS """GetLastErrorString"""
.el .SS "\f(CWGetLastErrorString\fP"
.IX Subsection "GetLastErrorString"
.Vb 1
\&  Padre::Util::Win32::GetLastError;
.Ve
.PP
Returns the error code of the last Win32 \s-1API\s0 call.
.PP
The list of error codes could be found at
<http://msdn.microsoft.com/en\-us/library/ms681381(\s-1VS.85\s0).aspx>.
.ie n .SS """GetLastErrorString"""
.el .SS "\f(CWGetLastErrorString\fP"
.IX Subsection "GetLastErrorString"
.Vb 1
\&  Padre::Util::Win32::GetLastErrorString;
.Ve
.PP
Returns the string representation for the error code of the last
Win32 \s-1API\s0 call.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2008\-2013 The Padre development team as listed in Padre.pm.
.PP
This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.
.PP
The full text of the license can be found in the
\&\s-1LICENSE\s0 file included with this module.