ホーム › Media.Multimedia › AVIBuildFilterA

AVIBuildFilterA

関数

AVI対応ファイル形式のフィルター文字列を構築する(ANSI版)。

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

シグネチャ

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

HRESULT AVIBuildFilterA(
    LPSTR lpszFilter,
    INT cbFilter,
    BOOL fSaving
);

パラメーター

名前	型	方向	説明
lpszFilter	LPSTR	out	フィルター文字列を格納するバッファーへのポインターです。
cbFilter	INT	in	lpszFilter が指すバッファーのサイズ(文字数単位)です。
fSaving	BOOL	in	フィルターに読み取り形式と書き込み形式のどちらを含めるかを示すフラグです。書き込み形式を含める場合は TRUE を、読み取り形式を含める場合は FALSE を指定します。

戻り値の型: HRESULT

公式ドキュメント

AVIBuildFilter 関数は、その後 GetOpenFileName 関数または GetSaveFileName 関数で使用されるフィルター指定文字列を作成します。(ANSI)

戻り値

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

戻り値	説明
AVIERR_BUFFERTOOSMALL	バッファーサイズ cbFilter が、生成されたフィルター指定文字列より小さい場合に返されます。
AVIERR_MEMORY	読み取り操作を完了するのに十分なメモリがありませんでした。

解説(Remarks)

この関数は、AVIFile ライブラリがマルチメディアファイルの開く、読み取る、または書き込む処理に使用できるすべてのフィルター種類について、レジストリにアクセスします。ハードディスク上のフィルター DLL や形式を検索することはありません。

メモ

vfw.h ヘッダーは AVIBuildFilter をエイリアスとして定義しており、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)

各言語での呼び出し定義

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

HRESULT AVIBuildFilterA(
    LPSTR lpszFilter,
    INT cbFilter,
    BOOL fSaving
);

[DllImport("AVIFIL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int AVIBuildFilterA(
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszFilter,   // LPSTR out
    int cbFilter,   // INT
    bool fSaving   // BOOL
);

<DllImport("AVIFIL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function AVIBuildFilterA(
    <MarshalAs(UnmanagedType.LPStr)> lpszFilter As System.Text.StringBuilder,   ' LPSTR out
    cbFilter As Integer,   ' INT
    fSaving As Boolean   ' BOOL
) As Integer
End Function

' lpszFilter : LPSTR out
' cbFilter : INT
' fSaving : BOOL
Declare PtrSafe Function AVIBuildFilterA Lib "avifil32" ( _
    ByVal lpszFilter As String, _
    ByVal cbFilter As Long, _
    ByVal fSaving As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

AVIBuildFilterA = ctypes.windll.avifil32.AVIBuildFilterA
AVIBuildFilterA.restype = ctypes.c_int
AVIBuildFilterA.argtypes = [
    wintypes.LPSTR,  # lpszFilter : LPSTR out
    ctypes.c_int,  # cbFilter : INT
    wintypes.BOOL,  # fSaving : BOOL
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('AVIFIL32.dll')
AVIBuildFilterA = Fiddle::Function.new(
  lib['AVIBuildFilterA'],
  [
    Fiddle::TYPE_VOIDP,  # lpszFilter : LPSTR out
    Fiddle::TYPE_INT,  # cbFilter : INT
    Fiddle::TYPE_INT,  # fSaving : BOOL
  ],
  Fiddle::TYPE_INT)

#[link(name = "avifil32")]
extern "system" {
    fn AVIBuildFilterA(
        lpszFilter: *mut u8,  // LPSTR out
        cbFilter: i32,  // INT
        fSaving: i32  // BOOL
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("AVIFIL32.dll", CharSet = CharSet.Ansi)]
public static extern int AVIBuildFilterA([MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszFilter, int cbFilter, bool fSaving);
"@
$api = Add-Type -MemberDefinition $sig -Name 'AVIFIL32_AVIBuildFilterA' -Namespace Win32 -PassThru
# $api::AVIBuildFilterA(lpszFilter, cbFilter, fSaving)

#uselib "AVIFIL32.dll"
#func global AVIBuildFilterA "AVIBuildFilterA" sptr, sptr, sptr
; AVIBuildFilterA varptr(lpszFilter), cbFilter, fSaving   ; 戻り値は stat
; lpszFilter : LPSTR out -> "sptr"
; cbFilter : INT -> "sptr"
; fSaving : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "AVIFIL32.dll"
#cfunc global AVIBuildFilterA "AVIBuildFilterA" var, int, int
; res = AVIBuildFilterA(lpszFilter, cbFilter, fSaving)
; lpszFilter : LPSTR out -> "var"
; cbFilter : INT -> "int"
; fSaving : BOOL -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "AVIFIL32.dll"
#cfunc global AVIBuildFilterA "AVIBuildFilterA" sptr, int, int
; res = AVIBuildFilterA(varptr(lpszFilter), cbFilter, fSaving)
; lpszFilter : LPSTR out -> "sptr"
; cbFilter : INT -> "int"
; fSaving : BOOL -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。