AVIFileOpenA

関数

AVIファイルを開いてインターフェイスを取得する(ANSI版)。

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

シグネチャ

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

HRESULT AVIFileOpenA(
    IAVIFile** ppfile,
    LPCSTR szFile,
    DWORD uMode,
    GUID* lpHandler   // optional
);

パラメーター

名前

型

方向

説明

ppfile

IAVIFile**

out

新しい IAVIFile インターフェイスポインターを受け取るバッファーへのポインター。

szFile

LPCSTR

開くファイルの名前を含む null 終端文字列。

uMode

DWORD

ファイルを開くときに使用するアクセスモード。既定のアクセスモードは 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	書き込み用にファイルを開きます。

lpHandler

GUID*

inoptional

使用する標準ハンドラーまたはカスタムハンドラーのクラス識別子へのポインター。値が NULL の場合、システムはファイル拡張子またはファイルで指定された RIFF タイプに基づいて、レジストリからハンドラーを選択します。

戻り値の型: HRESULT

公式ドキュメント

AVIFileOpen 関数は AVI ファイルを開き、そのファイルへのアクセスに使用するファイルインターフェイスのアドレスを返します。(AVIFileOpenA)

戻り値

成功した場合は 0 を、それ以外の場合はエラーを返します。発生し得るエラー値には次のものが含まれます。

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

解説(Remarks)

メモ

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

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

各言語での呼び出し定義

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

HRESULT AVIFileOpenA(
    IAVIFile** ppfile,
    LPCSTR szFile,
    DWORD uMode,
    GUID* lpHandler   // optional
);

[DllImport("AVIFIL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int AVIFileOpenA(
    IntPtr ppfile,   // IAVIFile** out
    [MarshalAs(UnmanagedType.LPStr)] string szFile,   // LPCSTR
    uint uMode,   // DWORD
    IntPtr lpHandler   // GUID* optional
);

<DllImport("AVIFIL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function AVIFileOpenA(
    ppfile As IntPtr,   ' IAVIFile** out
    <MarshalAs(UnmanagedType.LPStr)> szFile As String,   ' LPCSTR
    uMode As UInteger,   ' DWORD
    lpHandler As IntPtr   ' GUID* optional
) As Integer
End Function

' ppfile : IAVIFile** out
' szFile : LPCSTR
' uMode : DWORD
' lpHandler : GUID* optional
Declare PtrSafe Function AVIFileOpenA Lib "avifil32" ( _
    ByVal ppfile As LongPtr, _
    ByVal szFile As String, _
    ByVal uMode As Long, _
    ByVal lpHandler As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

AVIFileOpenA = ctypes.windll.avifil32.AVIFileOpenA
AVIFileOpenA.restype = ctypes.c_int
AVIFileOpenA.argtypes = [
    ctypes.c_void_p,  # ppfile : IAVIFile** out
    wintypes.LPCSTR,  # szFile : LPCSTR
    wintypes.DWORD,  # uMode : DWORD
    ctypes.c_void_p,  # lpHandler : GUID* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('AVIFIL32.dll')
AVIFileOpenA = Fiddle::Function.new(
  lib['AVIFileOpenA'],
  [
    Fiddle::TYPE_VOIDP,  # ppfile : IAVIFile** out
    Fiddle::TYPE_VOIDP,  # szFile : LPCSTR
    -Fiddle::TYPE_INT,  # uMode : DWORD
    Fiddle::TYPE_VOIDP,  # lpHandler : GUID* optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "avifil32")]
extern "system" {
    fn AVIFileOpenA(
        ppfile: *mut *mut core::ffi::c_void,  // IAVIFile** out
        szFile: *const u8,  // LPCSTR
        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.Ansi)]
public static extern int AVIFileOpenA(IntPtr ppfile, [MarshalAs(UnmanagedType.LPStr)] string szFile, uint uMode, IntPtr lpHandler);
"@
$api = Add-Type -MemberDefinition $sig -Name 'AVIFIL32_AVIFileOpenA' -Namespace Win32 -PassThru
# $api::AVIFileOpenA(ppfile, szFile, uMode, lpHandler)

#uselib "AVIFIL32.dll"
#func global AVIFileOpenA "AVIFileOpenA" sptr, sptr, sptr, sptr
; AVIFileOpenA ppfile, szFile, uMode, varptr(lpHandler)   ; 戻り値は stat
; ppfile : IAVIFile** out -> "sptr"
; szFile : LPCSTR -> "sptr"
; uMode : DWORD -> "sptr"
; lpHandler : GUID* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "AVIFIL32.dll"
#cfunc global AVIFileOpenA "AVIFileOpenA" sptr, str, int, var
; res = AVIFileOpenA(ppfile, szFile, uMode, lpHandler)
; ppfile : IAVIFile** out -> "sptr"
; szFile : LPCSTR -> "str"
; uMode : DWORD -> "int"
; lpHandler : GUID* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "AVIFIL32.dll"
#cfunc global AVIFileOpenA "AVIFileOpenA" sptr, str, int, sptr
; res = AVIFileOpenA(ppfile, szFile, uMode, varptr(lpHandler))
; ppfile : IAVIFile** out -> "sptr"
; szFile : LPCSTR -> "str"
; uMode : DWORD -> "int"
; lpHandler : GUID* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。