FileGetVersion.htm | searchcode

/AutoHotkey.docset/Contents/Resources/Documents/commands/FileGetVersion.htm

https://gitlab.com/ahkscript/Autohotkey.docset
HTML | 42 lines | 33 code | 9 blank | 0 comment | 0 complexity | 0b54a2eb6a931f7d3583acde588feebd MD5 | raw file


<!DOCTYPE HTML>
<html>
<head>
<title>FileGetVersion</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<link href="../static/theme.css" rel="stylesheet" type="text/css" />
<script src="../static/content.js" type="text/javascript"></script>
</head>
<body>

<h1>FileGetVersion</h1>

<p>Retrieves the version of a file.</p>

<pre class="Syntax">FileGetVersion, OutputVar [, Filename]</pre>
<h3>Parameters</h3>
<dl>

  <dt>OutputVar</dt>
  <dd><p>The name of the variable in which to store the version number/string.</p></dd>

  <dt>Filename</dt>
  <dd><p>The name of the target file. If a full path is not specified, this function uses the search sequence specified by the system <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms684175">LoadLibrary</a> function. If omitted, the current file of the innermost enclosing <a href="LoopFile.htm">File-Loop</a> will be used instead.</p></dd>

</dl>

<h3>ErrorLevel</h3>
<p><span class="ver">[v1.1.04+]</span> This command is able to throw an exception on failure. For more information, see <a href="Catch.htm#RuntimeErrors">Runtime Errors</a>.</p>
<p><a href="../misc/ErrorLevel.htm">ErrorLevel</a> is set to 1 if there was a problem or 0 otherwise.</p>
<p><a href="../Variables.htm#LastError">A_LastError</a> is set to the result of the operating system's GetLastError() function.</p>

<h3>Remarks</h3>
<p>Most non-executable files (and even some EXEs) won't have a version, and thus the OutputVar will be blank in these cases.</p>
<h3>Related</h3>
<p><a href="FileGetAttrib.htm">FileGetAttrib</a>, <a href="FileSetAttrib.htm">FileSetAttrib</a>, <a href="FileGetTime.htm">FileGetTime</a>, <a href="FileSetTime.htm">FileSetTime</a>, <a href="FileGetSize.htm">FileGetSize</a>, <a href="LoopFile.htm">File-loop</a></p>
<h3>Example</h3>
<pre class="NoIndent">FileGetVersion, version, C:\My Application.exe
FileGetVersion, version, %A_ProgramFiles%\AutoHotkey\AutoHotkey.exe</pre>

</body>
</html>