VerFindFileA

関数

インストール先となるファイルの配置場所を判定する(ANSI版)。

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

シグネチャ

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

VER_FIND_FILE_STATUS VerFindFileA(
    VER_FIND_FILE_FLAGS uFlags,
    LPCSTR szFileName,
    LPCSTR szWinDir,   // optional
    LPCSTR szAppDir,
    LPSTR szCurDir,
    DWORD* puCurDirLen,
    LPSTR szDestDir,
    DWORD* puDestDirLen
);

パラメーター

名前型方向説明

uFlags

VER_FIND_FILE_FLAGS

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

値	意味
VFFF_ISSHAREDFILE 0x0001	ソースファイルは複数のアプリケーションで共有できます。アプリケーションはこの情報を利用して、ファイルのコピー先を決定できます。

szFileName LPCSTR in インストールするファイルの名前。パスは含めず、ファイル名と拡張子のみを指定します。

szWinDir LPCSTR inoptional Windows が実行されている、または実行されるディレクトリ。この文字列は GetWindowsDirectory 関数によって返されます。

szAppDir LPCSTR in インストールプログラムが一連の関連ファイルをインストールするディレクトリ。インストールプログラムがアプリケーションをインストールする場合、これはアプリケーションが配置されるディレクトリです。特に指定がない限り、このパラメーターはアプリケーションの現在のディレクトリも指します。

szCurDir LPSTR out インストール対象ファイルの現在のバージョンへのパスを受け取るバッファー。パスは null 終端文字列です。現在のバージョンがインストールされていない場合、バッファーには長さ 0 の文字列が格納されます。バッファーは少なくとも _MAX_PATH 文字の長さが必要ですが、必須ではありません。

puCurDirLen

DWORD*

inout

                <i>szCurDir</i> バッファーの長さ。このポインターを <b>NULL</b> にすることはできません。

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

szDestDir LPSTR out VerFindFile が推奨するインストール先へのパスを受け取るバッファー。パスは null 終端文字列です。バッファーは少なくとも _MAX_PATH 文字の長さが必要ですが、必須ではありません。

puDestDirLen

DWORD*

inout

                <i>szDestDir</i> バッファーの長さを指定する変数へのポインター。このポインターを <b>NULL</b> にすることはできません。

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

戻り値の型: VER_FIND_FILE_STATUS

公式ドキュメント

システム内に別バージョンのファイルが存在するかどうかを判定し、その結果に基づいてファイルのインストール先を決定します。VerFindFile が指定されたバッファーに返す値は、後続の VerInstallFile 関数の呼び出しで使用されます。(ANSI)

戻り値

型: DWORD

戻り値は、ファイルの状態を示すビットマスクです。次の値のうち 1 つ以上が設定されることがあります。その他の値はすべて予約されています。

リターンコード/値	説明
VFF_CURNEDEST 0x0001	現在インストールされているバージョンのファイルが、推奨されるインストール先に存在しません。
VFF_FILEINUSE 0x0002	システムが現在インストールされているバージョンのファイルを使用しているため、ファイルを上書きまたは削除できません。
VFF_BUFFTOOSMALL 0x0004	少なくとも 1 つのバッファーが、対応する文字列を格納するには小さすぎました。アプリケーションは出力バッファーを確認し、どのバッファーが小さすぎたかを判定する必要があります。

解説(Remarks)

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

VerFindFile は、OpenFile 関数を使用して、指定されたファイルのコピーを検索します。ただし、システムディレクトリは指定された Windows ディレクトリから判定するか、パスを検索して特定します。

            <i>dwFlags</i> パラメーターがファイルをこのアプリケーション専用(<b>VFFF_ISSHAREDFILE</b> ではない)と示している場合、<b>VerFindFile</b> はアプリケーションのディレクトリへのインストールを推奨します。それ以外で、システムが共有コピーのシステムを実行している場合、関数は Windows ディレクトリへのインストールを推奨します。システムがプライベートコピーのシステムを実行している場合、関数はシステムディレクトリへのインストールを推奨します。

メモ

winver.h ヘッダーは VerFindFile をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じてコンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、「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_FIND_FILE_STATUS VerFindFileA(
    VER_FIND_FILE_FLAGS uFlags,
    LPCSTR szFileName,
    LPCSTR szWinDir,   // optional
    LPCSTR szAppDir,
    LPSTR szCurDir,
    DWORD* puCurDirLen,
    LPSTR szDestDir,
    DWORD* puDestDirLen
);

[DllImport("VERSION.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint VerFindFileA(
    uint uFlags,   // VER_FIND_FILE_FLAGS
    [MarshalAs(UnmanagedType.LPStr)] string szFileName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string szWinDir,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string szAppDir,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szCurDir,   // LPSTR out
    ref uint puCurDirLen,   // DWORD* in/out
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szDestDir,   // LPSTR out
    ref uint puDestDirLen   // DWORD* in/out
);

<DllImport("VERSION.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function VerFindFileA(
    uFlags As UInteger,   ' VER_FIND_FILE_FLAGS
    <MarshalAs(UnmanagedType.LPStr)> szFileName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> szWinDir As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> szAppDir As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> szCurDir As System.Text.StringBuilder,   ' LPSTR out
    ByRef puCurDirLen As UInteger,   ' DWORD* in/out
    <MarshalAs(UnmanagedType.LPStr)> szDestDir As System.Text.StringBuilder,   ' LPSTR out
    ByRef puDestDirLen As UInteger   ' DWORD* in/out
) As UInteger
End Function

' uFlags : VER_FIND_FILE_FLAGS
' szFileName : LPCSTR
' szWinDir : LPCSTR optional
' szAppDir : LPCSTR
' szCurDir : LPSTR out
' puCurDirLen : DWORD* in/out
' szDestDir : LPSTR out
' puDestDirLen : DWORD* in/out
Declare PtrSafe Function VerFindFileA Lib "version" ( _
    ByVal uFlags As Long, _
    ByVal szFileName As String, _
    ByVal szWinDir As String, _
    ByVal szAppDir As String, _
    ByVal szCurDir As String, _
    ByRef puCurDirLen As Long, _
    ByVal szDestDir As String, _
    ByRef puDestDirLen As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

VerFindFileA = ctypes.windll.version.VerFindFileA
VerFindFileA.restype = wintypes.DWORD
VerFindFileA.argtypes = [
    wintypes.DWORD,  # uFlags : VER_FIND_FILE_FLAGS
    wintypes.LPCSTR,  # szFileName : LPCSTR
    wintypes.LPCSTR,  # szWinDir : LPCSTR optional
    wintypes.LPCSTR,  # szAppDir : LPCSTR
    wintypes.LPSTR,  # szCurDir : LPSTR out
    ctypes.POINTER(wintypes.DWORD),  # puCurDirLen : DWORD* in/out
    wintypes.LPSTR,  # szDestDir : LPSTR out
    ctypes.POINTER(wintypes.DWORD),  # puDestDirLen : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('VERSION.dll')
VerFindFileA = Fiddle::Function.new(
  lib['VerFindFileA'],
  [
    -Fiddle::TYPE_INT,  # uFlags : VER_FIND_FILE_FLAGS
    Fiddle::TYPE_VOIDP,  # szFileName : LPCSTR
    Fiddle::TYPE_VOIDP,  # szWinDir : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # szAppDir : LPCSTR
    Fiddle::TYPE_VOIDP,  # szCurDir : LPSTR out
    Fiddle::TYPE_VOIDP,  # puCurDirLen : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # szDestDir : LPSTR out
    Fiddle::TYPE_VOIDP,  # puDestDirLen : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "version")]
extern "system" {
    fn VerFindFileA(
        uFlags: u32,  // VER_FIND_FILE_FLAGS
        szFileName: *const u8,  // LPCSTR
        szWinDir: *const u8,  // LPCSTR optional
        szAppDir: *const u8,  // LPCSTR
        szCurDir: *mut u8,  // LPSTR out
        puCurDirLen: *mut u32,  // DWORD* in/out
        szDestDir: *mut u8,  // LPSTR out
        puDestDirLen: *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 VerFindFileA(uint uFlags, [MarshalAs(UnmanagedType.LPStr)] string szFileName, [MarshalAs(UnmanagedType.LPStr)] string szWinDir, [MarshalAs(UnmanagedType.LPStr)] string szAppDir, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szCurDir, ref uint puCurDirLen, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szDestDir, ref uint puDestDirLen);
"@
$api = Add-Type -MemberDefinition $sig -Name 'VERSION_VerFindFileA' -Namespace Win32 -PassThru
# $api::VerFindFileA(uFlags, szFileName, szWinDir, szAppDir, szCurDir, puCurDirLen, szDestDir, puDestDirLen)

#uselib "VERSION.dll"
#func global VerFindFileA "VerFindFileA" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; VerFindFileA uFlags, szFileName, szWinDir, szAppDir, varptr(szCurDir), varptr(puCurDirLen), varptr(szDestDir), varptr(puDestDirLen)   ; 戻り値は stat
; uFlags : VER_FIND_FILE_FLAGS -> "sptr"
; szFileName : LPCSTR -> "sptr"
; szWinDir : LPCSTR optional -> "sptr"
; szAppDir : LPCSTR -> "sptr"
; szCurDir : LPSTR out -> "sptr"
; puCurDirLen : DWORD* in/out -> "sptr"
; szDestDir : LPSTR out -> "sptr"
; puDestDirLen : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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