ホーム › Storage.FileSystem › VerInstallFileA

VerInstallFileA

関数

バージョンを確認しながらファイルをインストールする(ANSI版)。

DLLVERSION.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// VERSION.dll  (ANSI / -A)
#include <windows.h>

VER_INSTALL_FILE_STATUS VerInstallFileA(
    VER_INSTALL_FILE_FLAGS uFlags,
    LPCSTR szSrcFileName,
    LPCSTR szDestFileName,
    LPCSTR szSrcDir,
    LPCSTR szDestDir,
    LPCSTR szCurDir,
    LPSTR szTmpFile,
    DWORD* puTmpFileLen
);

パラメーター

名前型方向説明

uFlags

VER_INSTALL_FILE_FLAGS

このパラメーターには、次のいずれかの値を指定できます。その他のすべてのビットは予約されています。

値	意味
VIFF_FORCEINSTALL 0x0001	バージョン番号の不一致に関係なくファイルをインストールします。この関数は、インストール中の物理的なエラーのみをチェックします。
VIFF_DONTDELETEOLD 0x0002	以前にインストールされたファイルが対象ディレクトリにない場合、そのファイルを削除せずにファイルをインストールします。

szSrcFileName LPCSTR in インストールするファイルの名前。これは szSrcDir パラメーターが指すディレクトリ内のファイル名です。ファイル名にはファイル名と拡張子のみを含めることができ、パスを含めることはできません。

szDestFileName LPCSTR in インストール時に VerInstallFile が新しいファイルに付ける名前。このファイル名は szSrcFileName ディレクトリ内のファイル名と異なる場合があります。新しい名前にはファイル名と拡張子のみを含め、パスを含めないでください。

szSrcDir LPCSTR in ファイルが存在するディレクトリの名前。

szDestDir LPCSTR in ファイルをインストールするディレクトリの名前。VerFindFile は、この値を szDestDir パラメーターで返します。

szCurDir LPCSTR in このファイルの既存バージョンが存在するディレクトリの名前。VerFindFile は、この値を szCurDir パラメーターで返します。

szTmpFile LPSTR out ソースファイルの一時コピーの名前。バッファーは、必須ではありませんが少なくとも _MAX_PATH 文字の長さである必要があり、入力時には空である必要があります。

puTmpFileLen

DWORD*

inout

                <i>szTmpFile</i> バッファーの長さ。このポインターは <b>NULL</b> であってはなりません。

関数が戻ると、 lpuTmpFileLen には、終端の null 文字を含む、 szTmpFile に返されたデータのサイズ(文字単位)が格納されます。バッファーがすべてのデータを格納するには小さすぎる場合、 lpuTmpFileLen はデータを保持するために必要なバッファーのサイズになります。

戻り値の型: VER_INSTALL_FILE_STATUS

公式ドキュメント

VerFindFile 関数から返された情報に基づいて、指定されたファイルをインストールします。VerInstallFile は、必要に応じてファイルを展開し、一意のファイル名を割り当て、古いファイルなどのエラーをチェックします。(ANSI)

戻り値

型: DWORD

戻り値は、例外を示すビットマスクです。次の値の 1 つ以上を組み合わせて返されます。その他のすべての値は予約されています。

リターンコード/値	説明
VIF_ACCESSVIOLATION 0x00000200L	アクセス違反のため、読み取り、作成、削除、または名前変更の操作が失敗しました。
VIF_BUFFTOOSMALL 0x00040000L	szTmpFile バッファーが、一時ソースファイルの名前を格納するには小さすぎました。関数が戻ると、lpuTmpFileLen にはファイル名を保持するために必要なバッファーのサイズが格納されます。
VIF_CANNOTCREATE 0x00000800L	関数が一時ファイルを作成できません。具体的なエラーは別のフラグで示される場合があります。
VIF_CANNOTDELETE 0x00001000L	関数が対象ファイルを削除できないか、別のディレクトリにあるファイルの既存バージョンを削除できません。VIF_TEMPFILE ビットが設定されている場合、インストールは失敗しており、対象ファイルはおそらく削除できません。
VIF_CANNOTDELETECUR 0x00004000L	ファイルの既存バージョンを削除できず、VIFF_DONTDELETEOLD が指定されていませんでした。
VIF_CANNOTLOADCABINET 0x00100000L	関数がキャビネットファイルを読み込めません。
VIF_CANNOTLOADLZ32 0x00080000L	関数が圧縮ファイルを読み込めません。
VIF_CANNOTREADDST 0x00020000L	関数が対象(既存)ファイルを読み取れません。これにより、関数はファイルの属性を調べることができません。
VIF_CANNOTREADSRC 0x00010000L	関数がソースファイルを読み取れません。これは、パスが正しく指定されていなかったことを意味する場合があります。
VIF_CANNOTRENAME 0x00002000L	関数が一時ファイルの名前を変更できませんが、対象ファイルは既に削除しています。
VIF_DIFFCODEPG 0x00000010L	新しいファイルは、現在実行中のシステムのバージョンでは表示できないコードページを必要とします。このエラーは、VIFF_FORCEINSTALL フラグを設定して VerInstallFile を呼び出すことでオーバーライドできます。
VIF_DIFFLANG 0x00000008L	新しいファイルと既存のファイルで、言語またはコードページの値が異なります。このエラーは、VIFF_FORCEINSTALL フラグを設定して VerInstallFile を再度呼び出すことでオーバーライドできます。
VIF_DIFFTYPE 0x00000020L	新しいファイルは、既存のファイルとは異なる種類、サブタイプ、またはオペレーティングシステムを持っています。このエラーは、VIFF_FORCEINSTALL フラグを設定して VerInstallFile を再度呼び出すことでオーバーライドできます。
VIF_FILEINUSE 0x00000080L	既存のファイルはシステムで使用中であり、削除できません。
VIF_MISMATCH 0x00000002L	新しいファイルと既存のファイルで、1 つ以上の属性が異なります。このエラーは、VIFF_FORCEINSTALL フラグを設定して VerInstallFile を再度呼び出すことでオーバーライドできます。
VIF_OUTOFMEMORY 0x00008000L	メモリ不足のため、関数は要求された操作を完了できません。一般に、これはアプリケーションが圧縮ファイルを展開しようとしてメモリ不足になったことを意味します。
VIF_OUTOFSPACE 0x00000100L	対象ドライブのディスク容量が不足しているため、関数は一時ファイルを作成できません。
VIF_SHARINGVIOLATION 0x00000400L	共有違反のため、読み取り、作成、削除、または名前変更の操作が失敗しました。
VIF_SRCOLD 0x00000004L	インストールするファイルが既存のファイルより古いです。このエラーは、VIFF_FORCEINSTALL フラグを設定して VerInstallFile を再度呼び出すことでオーバーライドできます。
VIF_TEMPFILE 0x00000001L	新しいファイルの一時コピーが対象ディレクトリにあります。失敗の原因は他のフラグに反映されます。
VIF_WRITEPROT 0x00000040L	既存のファイルは書き込み保護されています。このエラーは、VIFF_FORCEINSTALL フラグを設定して VerInstallFile を再度呼び出すことでオーバーライドできます。

解説(Remarks)

この関数は、16 ビット、32 ビット、および 64 ビットのファイルイメージで動作します。

VerInstallFile は、ソースディレクトリから対象ディレクトリにファイルをコピーします。 szCurDir がファイルの以前のバージョンがシステムに存在することを示している場合、VerInstallFile はファイルのバージョンスタンプ情報を比較します。以前にインストールされたバージョンのファイルが新しいバージョンより新しい場合、またはファイルの属性が大きく異なる場合(たとえば、言語が異なる場合)、VerInstallFile は 1 つ以上の回復可能なエラーコードを返します。

VerInstallFile は、一時ファイルを対象ディレクトリに残します。アプリケーションは、エラーをオーバーライドするか、一時ファイルを削除することができます。アプリケーションがエラーをオーバーライドすると、VerInstallFile は以前にインストールされたバージョンを削除し、一時ファイルの名前を元のファイル名に変更します。

メモ

winver.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして VerInstallFile を定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じ、コンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// VERSION.dll  (ANSI / -A)
#include <windows.h>

VER_INSTALL_FILE_STATUS VerInstallFileA(
    VER_INSTALL_FILE_FLAGS uFlags,
    LPCSTR szSrcFileName,
    LPCSTR szDestFileName,
    LPCSTR szSrcDir,
    LPCSTR szDestDir,
    LPCSTR szCurDir,
    LPSTR szTmpFile,
    DWORD* puTmpFileLen
);

[DllImport("VERSION.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint VerInstallFileA(
    uint uFlags,   // VER_INSTALL_FILE_FLAGS
    [MarshalAs(UnmanagedType.LPStr)] string szSrcFileName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string szDestFileName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string szSrcDir,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string szDestDir,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string szCurDir,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szTmpFile,   // LPSTR out
    ref uint puTmpFileLen   // DWORD* in/out
);

<DllImport("VERSION.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function VerInstallFileA(
    uFlags As UInteger,   ' VER_INSTALL_FILE_FLAGS
    <MarshalAs(UnmanagedType.LPStr)> szSrcFileName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> szDestFileName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> szSrcDir As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> szDestDir As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> szCurDir As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> szTmpFile As System.Text.StringBuilder,   ' LPSTR out
    ByRef puTmpFileLen As UInteger   ' DWORD* in/out
) As UInteger
End Function

' uFlags : VER_INSTALL_FILE_FLAGS
' szSrcFileName : LPCSTR
' szDestFileName : LPCSTR
' szSrcDir : LPCSTR
' szDestDir : LPCSTR
' szCurDir : LPCSTR
' szTmpFile : LPSTR out
' puTmpFileLen : DWORD* in/out
Declare PtrSafe Function VerInstallFileA Lib "version" ( _
    ByVal uFlags As Long, _
    ByVal szSrcFileName As String, _
    ByVal szDestFileName As String, _
    ByVal szSrcDir As String, _
    ByVal szDestDir As String, _
    ByVal szCurDir As String, _
    ByVal szTmpFile As String, _
    ByRef puTmpFileLen As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

VerInstallFileA = ctypes.windll.version.VerInstallFileA
VerInstallFileA.restype = wintypes.DWORD
VerInstallFileA.argtypes = [
    wintypes.DWORD,  # uFlags : VER_INSTALL_FILE_FLAGS
    wintypes.LPCSTR,  # szSrcFileName : LPCSTR
    wintypes.LPCSTR,  # szDestFileName : LPCSTR
    wintypes.LPCSTR,  # szSrcDir : LPCSTR
    wintypes.LPCSTR,  # szDestDir : LPCSTR
    wintypes.LPCSTR,  # szCurDir : LPCSTR
    wintypes.LPSTR,  # szTmpFile : LPSTR out
    ctypes.POINTER(wintypes.DWORD),  # puTmpFileLen : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('VERSION.dll')
VerInstallFileA = Fiddle::Function.new(
  lib['VerInstallFileA'],
  [
    -Fiddle::TYPE_INT,  # uFlags : VER_INSTALL_FILE_FLAGS
    Fiddle::TYPE_VOIDP,  # szSrcFileName : LPCSTR
    Fiddle::TYPE_VOIDP,  # szDestFileName : LPCSTR
    Fiddle::TYPE_VOIDP,  # szSrcDir : LPCSTR
    Fiddle::TYPE_VOIDP,  # szDestDir : LPCSTR
    Fiddle::TYPE_VOIDP,  # szCurDir : LPCSTR
    Fiddle::TYPE_VOIDP,  # szTmpFile : LPSTR out
    Fiddle::TYPE_VOIDP,  # puTmpFileLen : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "version")]
extern "system" {
    fn VerInstallFileA(
        uFlags: u32,  // VER_INSTALL_FILE_FLAGS
        szSrcFileName: *const u8,  // LPCSTR
        szDestFileName: *const u8,  // LPCSTR
        szSrcDir: *const u8,  // LPCSTR
        szDestDir: *const u8,  // LPCSTR
        szCurDir: *const u8,  // LPCSTR
        szTmpFile: *mut u8,  // LPSTR out
        puTmpFileLen: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("VERSION.dll", CharSet = CharSet.Ansi)]
public static extern uint VerInstallFileA(uint uFlags, [MarshalAs(UnmanagedType.LPStr)] string szSrcFileName, [MarshalAs(UnmanagedType.LPStr)] string szDestFileName, [MarshalAs(UnmanagedType.LPStr)] string szSrcDir, [MarshalAs(UnmanagedType.LPStr)] string szDestDir, [MarshalAs(UnmanagedType.LPStr)] string szCurDir, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szTmpFile, ref uint puTmpFileLen);
"@
$api = Add-Type -MemberDefinition $sig -Name 'VERSION_VerInstallFileA' -Namespace Win32 -PassThru
# $api::VerInstallFileA(uFlags, szSrcFileName, szDestFileName, szSrcDir, szDestDir, szCurDir, szTmpFile, puTmpFileLen)

#uselib "VERSION.dll"
#func global VerInstallFileA "VerInstallFileA" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; VerInstallFileA uFlags, szSrcFileName, szDestFileName, szSrcDir, szDestDir, szCurDir, varptr(szTmpFile), varptr(puTmpFileLen)   ; 戻り値は stat
; uFlags : VER_INSTALL_FILE_FLAGS -> "sptr"
; szSrcFileName : LPCSTR -> "sptr"
; szDestFileName : LPCSTR -> "sptr"
; szSrcDir : LPCSTR -> "sptr"
; szDestDir : LPCSTR -> "sptr"
; szCurDir : LPCSTR -> "sptr"
; szTmpFile : LPSTR out -> "sptr"
; puTmpFileLen : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "VERSION.dll"
#cfunc global VerInstallFileA "VerInstallFileA" int, str, str, str, str, str, var, var
; res = VerInstallFileA(uFlags, szSrcFileName, szDestFileName, szSrcDir, szDestDir, szCurDir, szTmpFile, puTmpFileLen)
; uFlags : VER_INSTALL_FILE_FLAGS -> "int"
; szSrcFileName : LPCSTR -> "str"
; szDestFileName : LPCSTR -> "str"
; szSrcDir : LPCSTR -> "str"
; szDestDir : LPCSTR -> "str"
; szCurDir : LPCSTR -> "str"
; szTmpFile : LPSTR out -> "var"
; puTmpFileLen : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "VERSION.dll"
#cfunc global VerInstallFileA "VerInstallFileA" int, str, str, str, str, str, sptr, sptr
; res = VerInstallFileA(uFlags, szSrcFileName, szDestFileName, szSrcDir, szDestDir, szCurDir, varptr(szTmpFile), varptr(puTmpFileLen))
; uFlags : VER_INSTALL_FILE_FLAGS -> "int"
; szSrcFileName : LPCSTR -> "str"
; szDestFileName : LPCSTR -> "str"
; szSrcDir : LPCSTR -> "str"
; szDestDir : LPCSTR -> "str"
; szCurDir : LPCSTR -> "str"
; szTmpFile : LPSTR out -> "sptr"
; puTmpFileLen : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。