Win32 API 日本語リファレンス
ホームMedia.Multimedia › AVIFileOpenW

AVIFileOpenW

関数
AVIファイルを開いてインターフェイスを取得する(Unicode版)。
DLLAVIFIL32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// AVIFIL32.dll  (Unicode / -W)
#include <windows.h>

HRESULT AVIFileOpenW(
    IAVIFile** ppfile,
    LPCWSTR szFile,
    DWORD uMode,
    GUID* lpHandler   // optional
);

パラメーター

名前方向説明
ppfileIAVIFile**out新しい IAVIFile インターフェイスポインターを受け取るバッファーへのポインター。
szFileLPCWSTRin開くファイルの名前を格納した、null で終わる文字列。
uModeDWORDin

ファイルを開くときに使用するアクセスモード。既定のアクセスモードは OF_READ です。AVIFileOpen では次のアクセスモードを指定できます。

意味
OF_CREATE 新しいファイルを作成します。ファイルが既に存在する場合は、長さ 0 に切り詰められます。
OF_PARSE インデックスの構築など、時間のかかる処理をスキップします。たとえばファイルのプロパティを照会するだけで実際には読み取らない場合など、関数をできるだけ速く返したいときにこのフラグを設定します。
OF_READ 読み取り用にファイルを開きます。
OF_READWRITE 読み取りと書き込み用にファイルを開きます。
OF_SHARE_DENY_NONE ファイルを非排他的に開きます。他のプロセスは読み取りまたは書き込みアクセスでファイルを開くことができます。他のプロセスが互換モードでファイルを開いている場合、AVIFileOpen は失敗します。
OF_SHARE_DENY_READ ファイルを非排他的に開きます。他のプロセスは書き込みアクセスでファイルを開くことができます。他のプロセスが互換モードでファイルを開いている場合、またはそのファイルに対する読み取りアクセスを持っている場合、AVIFileOpen は失敗します。
OF_SHARE_DENY_WRITE ファイルを非排他的に開きます。他のプロセスは読み取りアクセスでファイルを開くことができます。他のプロセスが互換モードでファイルを開いている場合、またはそのファイルに対する書き込みアクセスを持っている場合、AVIFileOpen は失敗します。
OF_SHARE_EXCLUSIVE ファイルを開き、他のプロセスからのアクセスをすべて拒否します。他のいずれかのプロセスがファイルを開いている場合、AVIFileOpen は失敗します。
OF_WRITE 書き込み用にファイルを開きます。
lpHandlerGUID*inoptional使用する標準ハンドラーまたはカスタムハンドラーのクラス識別子へのポインター。値が NULL の場合、システムはファイル拡張子またはファイルで指定された RIFF タイプに基づいて、レジストリからハンドラーを選択します。

戻り値の型: HRESULT

公式ドキュメント

AVIFileOpenW 関数 (vfw.h) は、AVI ファイルを開き、それにアクセスするために使用するファイルインターフェイスのアドレスを返します。

戻り値

成功した場合は 0 を、それ以外の場合はエラーを返します。考えられるエラー値には次のものがあります。

戻り値 説明
AVIERR_BADFORMAT
ファイルを読み取れませんでした。ファイルが破損しているか、認識できない形式であることを示します。
AVIERR_MEMORY
メモリ不足のため、ファイルを開けませんでした。
AVIERR_FILEREAD
ファイルの読み取り中にディスクエラーが発生しました。
AVIERR_FILEOPEN
ファイルを開く際にディスクエラーが発生しました。
REGDB_E_CLASSNOTREG
レジストリによれば、AVIFileOpen で指定された種類のファイルを処理するハンドラーが存在しません。

解説(Remarks)

メモ

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

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

各言語での呼び出し定義

// AVIFIL32.dll  (Unicode / -W)
#include <windows.h>

HRESULT AVIFileOpenW(
    IAVIFile** ppfile,
    LPCWSTR szFile,
    DWORD uMode,
    GUID* lpHandler   // optional
);
[DllImport("AVIFIL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int AVIFileOpenW(
    IntPtr ppfile,   // IAVIFile** out
    [MarshalAs(UnmanagedType.LPWStr)] string szFile,   // LPCWSTR
    uint uMode,   // DWORD
    IntPtr lpHandler   // GUID* optional
);
<DllImport("AVIFIL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function AVIFileOpenW(
    ppfile As IntPtr,   ' IAVIFile** out
    <MarshalAs(UnmanagedType.LPWStr)> szFile As String,   ' LPCWSTR
    uMode As UInteger,   ' DWORD
    lpHandler As IntPtr   ' GUID* optional
) As Integer
End Function
' ppfile : IAVIFile** out
' szFile : LPCWSTR
' uMode : DWORD
' lpHandler : GUID* optional
Declare PtrSafe Function AVIFileOpenW Lib "avifil32" ( _
    ByVal ppfile As LongPtr, _
    ByVal szFile As LongPtr, _
    ByVal uMode As Long, _
    ByVal lpHandler As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

AVIFileOpenW = ctypes.windll.avifil32.AVIFileOpenW
AVIFileOpenW.restype = ctypes.c_int
AVIFileOpenW.argtypes = [
    ctypes.c_void_p,  # ppfile : IAVIFile** out
    wintypes.LPCWSTR,  # szFile : LPCWSTR
    wintypes.DWORD,  # uMode : DWORD
    ctypes.c_void_p,  # lpHandler : GUID* optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('AVIFIL32.dll')
AVIFileOpenW = Fiddle::Function.new(
  lib['AVIFileOpenW'],
  [
    Fiddle::TYPE_VOIDP,  # ppfile : IAVIFile** out
    Fiddle::TYPE_VOIDP,  # szFile : LPCWSTR
    -Fiddle::TYPE_INT,  # uMode : DWORD
    Fiddle::TYPE_VOIDP,  # lpHandler : GUID* optional
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "avifil32")]
extern "system" {
    fn AVIFileOpenW(
        ppfile: *mut *mut core::ffi::c_void,  // IAVIFile** out
        szFile: *const u16,  // LPCWSTR
        uMode: u32,  // DWORD
        lpHandler: *mut GUID  // GUID* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("AVIFIL32.dll", CharSet = CharSet.Unicode)]
public static extern int AVIFileOpenW(IntPtr ppfile, [MarshalAs(UnmanagedType.LPWStr)] string szFile, uint uMode, IntPtr lpHandler);
"@
$api = Add-Type -MemberDefinition $sig -Name 'AVIFIL32_AVIFileOpenW' -Namespace Win32 -PassThru
# $api::AVIFileOpenW(ppfile, szFile, uMode, lpHandler)
#uselib "AVIFIL32.dll"
#func global AVIFileOpenW "AVIFileOpenW" wptr, wptr, wptr, wptr
; AVIFileOpenW ppfile, szFile, uMode, varptr(lpHandler)   ; 戻り値は stat
; ppfile : IAVIFile** out -> "wptr"
; szFile : LPCWSTR -> "wptr"
; uMode : DWORD -> "wptr"
; lpHandler : GUID* optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "AVIFIL32.dll"
#cfunc global AVIFileOpenW "AVIFileOpenW" sptr, wstr, int, var
; res = AVIFileOpenW(ppfile, szFile, uMode, lpHandler)
; ppfile : IAVIFile** out -> "sptr"
; szFile : LPCWSTR -> "wstr"
; uMode : DWORD -> "int"
; lpHandler : GUID* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT AVIFileOpenW(IAVIFile** ppfile, LPCWSTR szFile, DWORD uMode, GUID* lpHandler)
#uselib "AVIFIL32.dll"
#cfunc global AVIFileOpenW "AVIFileOpenW" intptr, wstr, int, var
; res = AVIFileOpenW(ppfile, szFile, uMode, lpHandler)
; ppfile : IAVIFile** out -> "intptr"
; szFile : LPCWSTR -> "wstr"
; uMode : DWORD -> "int"
; lpHandler : GUID* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	avifil32 = windows.NewLazySystemDLL("AVIFIL32.dll")
	procAVIFileOpenW = avifil32.NewProc("AVIFileOpenW")
)

// ppfile (IAVIFile** out), szFile (LPCWSTR), uMode (DWORD), lpHandler (GUID* optional)
r1, _, err := procAVIFileOpenW.Call(
	uintptr(ppfile),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szFile))),
	uintptr(uMode),
	uintptr(lpHandler),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function AVIFileOpenW(
  ppfile: Pointer;   // IAVIFile** out
  szFile: PWideChar;   // LPCWSTR
  uMode: DWORD;   // DWORD
  lpHandler: PGUID   // GUID* optional
): Integer; stdcall;
  external 'AVIFIL32.dll' name 'AVIFileOpenW';
result := DllCall("AVIFIL32\AVIFileOpenW"
    , "Ptr", ppfile   ; IAVIFile** out
    , "WStr", szFile   ; LPCWSTR
    , "UInt", uMode   ; DWORD
    , "Ptr", lpHandler   ; GUID* optional
    , "Int")   ; return: HRESULT
●AVIFileOpenW(ppfile, szFile, uMode, lpHandler) = DLL("AVIFIL32.dll", "int AVIFileOpenW(void*, char*, dword, void*)")
# 呼び出し: AVIFileOpenW(ppfile, szFile, uMode, lpHandler)
# ppfile : IAVIFile** out -> "void*"
# szFile : LPCWSTR -> "char*"
# uMode : DWORD -> "dword"
# lpHandler : GUID* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "avifil32" fn AVIFileOpenW(
    ppfile: ?*anyopaque, // IAVIFile** out
    szFile: [*c]const u16, // LPCWSTR
    uMode: u32, // DWORD
    lpHandler: [*c]GUID // GUID* optional
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc AVIFileOpenW(
    ppfile: pointer,  # IAVIFile** out
    szFile: WideCString,  # LPCWSTR
    uMode: uint32,  # DWORD
    lpHandler: ptr GUID  # GUID* optional
): int32 {.importc: "AVIFileOpenW", stdcall, dynlib: "AVIFIL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "avifil32");
extern(Windows)
int AVIFileOpenW(
    void* ppfile,   // IAVIFile** out
    const(wchar)* szFile,   // LPCWSTR
    uint uMode,   // DWORD
    GUID* lpHandler   // GUID* optional
);
ccall((:AVIFileOpenW, "AVIFIL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cwstring, UInt32, Ptr{GUID}),
      ppfile, szFile, uMode, lpHandler)
# ppfile : IAVIFile** out -> Ptr{Cvoid}
# szFile : LPCWSTR -> Cwstring
# uMode : DWORD -> UInt32
# lpHandler : GUID* optional -> Ptr{GUID}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t AVIFileOpenW(
    void* ppfile,
    const uint16_t* szFile,
    uint32_t uMode,
    void* lpHandler);
]]
local avifil32 = ffi.load("avifil32")
-- avifil32.AVIFileOpenW(ppfile, szFile, uMode, lpHandler)
-- ppfile : IAVIFile** out
-- szFile : LPCWSTR
-- uMode : DWORD
-- lpHandler : GUID* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('AVIFIL32.dll');
const AVIFileOpenW = lib.func('__stdcall', 'AVIFileOpenW', 'int32_t', ['void *', 'str16', 'uint32_t', 'void *']);
// AVIFileOpenW(ppfile, szFile, uMode, lpHandler)
// ppfile : IAVIFile** out -> 'void *'
// szFile : LPCWSTR -> 'str16'
// uMode : DWORD -> 'uint32_t'
// lpHandler : GUID* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("AVIFIL32.dll", {
  AVIFileOpenW: { parameters: ["pointer", "buffer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.AVIFileOpenW(ppfile, szFile, uMode, lpHandler)
// ppfile : IAVIFile** out -> "pointer"
// szFile : LPCWSTR -> "buffer"
// uMode : DWORD -> "u32"
// lpHandler : GUID* optional -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t AVIFileOpenW(
    void* ppfile,
    const uint16_t* szFile,
    uint32_t uMode,
    void* lpHandler);
C, "AVIFIL32.dll");
// $ffi->AVIFileOpenW(ppfile, szFile, uMode, lpHandler);
// ppfile : IAVIFile** out
// szFile : LPCWSTR
// uMode : DWORD
// lpHandler : GUID* optional
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Avifil32 extends StdCallLibrary {
    Avifil32 INSTANCE = Native.load("avifil32", Avifil32.class, W32APIOptions.UNICODE_OPTIONS);
    int AVIFileOpenW(
        Pointer ppfile,   // IAVIFile** out
        WString szFile,   // LPCWSTR
        int uMode,   // DWORD
        Pointer lpHandler   // GUID* optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("avifil32")]
lib LibAVIFIL32
  fun AVIFileOpenW = AVIFileOpenW(
    ppfile : Void*,   # IAVIFile** out
    szFile : UInt16*,   # LPCWSTR
    uMode : UInt32,   # DWORD
    lpHandler : GUID*   # GUID* optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef AVIFileOpenWNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Uint32, Pointer<Void>);
typedef AVIFileOpenWDart = int Function(Pointer<Void>, Pointer<Utf16>, int, Pointer<Void>);
final AVIFileOpenW = DynamicLibrary.open('AVIFIL32.dll')
    .lookupFunction<AVIFileOpenWNative, AVIFileOpenWDart>('AVIFileOpenW');
// ppfile : IAVIFile** out -> Pointer<Void>
// szFile : LPCWSTR -> Pointer<Utf16>
// uMode : DWORD -> Uint32
// lpHandler : GUID* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function AVIFileOpenW(
  ppfile: Pointer;   // IAVIFile** out
  szFile: PWideChar;   // LPCWSTR
  uMode: DWORD;   // DWORD
  lpHandler: PGUID   // GUID* optional
): Integer; stdcall;
  external 'AVIFIL32.dll' name 'AVIFileOpenW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "AVIFileOpenW"
  c_AVIFileOpenW :: Ptr () -> CWString -> Word32 -> Ptr () -> IO Int32
-- ppfile : IAVIFile** out -> Ptr ()
-- szFile : LPCWSTR -> CWString
-- uMode : DWORD -> Word32
-- lpHandler : GUID* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let avifileopenw =
  foreign "AVIFileOpenW"
    ((ptr void) @-> (ptr uint16_t) @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* ppfile : IAVIFile** out -> (ptr void) *)
(* szFile : LPCWSTR -> (ptr uint16_t) *)
(* uMode : DWORD -> uint32_t *)
(* lpHandler : GUID* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library avifil32 (t "AVIFIL32.dll"))
(cffi:use-foreign-library avifil32)

(cffi:defcfun ("AVIFileOpenW" avifile-open-w :convention :stdcall) :int32
  (ppfile :pointer)   ; IAVIFile** out
  (sz-file (:string :encoding :utf-16le))   ; LPCWSTR
  (u-mode :uint32)   ; DWORD
  (lp-handler :pointer))   ; GUID* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $AVIFileOpenW = Win32::API::More->new('AVIFIL32',
    'int AVIFileOpenW(LPVOID ppfile, LPCWSTR szFile, DWORD uMode, LPVOID lpHandler)');
# my $ret = $AVIFileOpenW->Call($ppfile, $szFile, $uMode, $lpHandler);
# ppfile : IAVIFile** out -> LPVOID
# szFile : LPCWSTR -> LPCWSTR
# uMode : DWORD -> DWORD
# lpHandler : GUID* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目
使用する型