ホーム › Media.Multimedia › AVIBuildFilterW

AVIBuildFilterW

関数

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

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

シグネチャ

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

HRESULT AVIBuildFilterW(
    LPWSTR lpszFilter,
    INT cbFilter,
    BOOL fSaving
);

パラメーター

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

戻り値の型: HRESULT

公式ドキュメント

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

戻り値

成功した場合は 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  (Unicode / -W)
#include <windows.h>

HRESULT AVIBuildFilterW(
    LPWSTR lpszFilter,
    INT cbFilter,
    BOOL fSaving
);

[DllImport("AVIFIL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int AVIBuildFilterW(
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszFilter,   // LPWSTR out
    int cbFilter,   // INT
    bool fSaving   // BOOL
);

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

' lpszFilter : LPWSTR out
' cbFilter : INT
' fSaving : BOOL
Declare PtrSafe Function AVIBuildFilterW Lib "avifil32" ( _
    ByVal lpszFilter As LongPtr, _
    ByVal cbFilter As Long, _
    ByVal fSaving As Long) 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

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('AVIFIL32.dll')
AVIBuildFilterW = Fiddle::Function.new(
  lib['AVIBuildFilterW'],
  [
    Fiddle::TYPE_VOIDP,  # lpszFilter : LPWSTR out
    Fiddle::TYPE_INT,  # cbFilter : INT
    Fiddle::TYPE_INT,  # fSaving : BOOL
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

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

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

出力引数:

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