AVISaveOptions

関数

AVI圧縮オプションを設定するダイアログを表示しユーザーに選択させる。

DLLAVIFIL32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// AVIFIL32.dll
#include <windows.h>

INT_PTR AVISaveOptions(
    HWND hwnd,
    DWORD uiFlags,
    INT nStreams,
    IAVIStream** ppavi,
    AVICOMPRESSOPTIONS** plpOptions
);

パラメーター

名前

型

方向

説明

hwnd

HWND

圧縮オプション (Compression Options) ダイアログボックスの親ウィンドウへのハンドルです。

uiFlags

DWORD

圧縮オプションダイアログボックスを表示するためのフラグです。次のフラグが定義されています。

値	意味
ICMF_CHOOSE_KEYFRAME	ビデオオプション用に Key Frame Every ダイアログボックスを表示します。これは ICCompressorChoose 関数で使用されるフラグと同じものです。
ICMF_CHOOSE_DATARATE	ビデオオプション用に Data Rate ダイアログボックスを表示します。これは ICCompressorChoose で使用されるフラグと同じものです。
ICMF_CHOOSE_PREVIEW	ビデオオプション用に Preview ボタンを表示します。このボタンは、ストリームのフレームを使用して圧縮をプレビューします。これは ICCompressorChoose で使用されるフラグと同じものです。

nStreams

INT

ダイアログボックスでオプションを設定するストリームの数です。

ppavi

IAVIStream**

ストリームインターフェイスポインターの配列へのポインターです。nStreams パラメーターは、配列内のポインターの数を示します。

plpOptions

AVICOMPRESSOPTIONS**

inout

AVICOMPRESSOPTIONS 構造体へのポインターの配列へのポインターです。これらの構造体には、ダイアログボックスで設定された圧縮オプションが格納されます。nStreams パラメーターは、配列内のポインターの数を示します。

戻り値の型: INT_PTR

公式ドキュメント

AVISaveOptions 関数は、ファイルの保存オプションを取得し、バッファに格納して返します。

戻り値

ユーザーが OK を押した場合は TRUE、CANCEL の場合は FALSE、それ以外の場合はエラーを返します。

解説(Remarks)

この関数は、hwnd を親ウィンドウハンドルとして使用し、標準の圧縮オプションダイアログボックスを表示します。ユーザーが各ストリームの圧縮オプションの選択を完了すると、オプションは plpOptions が参照する配列内の AVICOMPRESSOPTIONS 構造体に返されます。呼び出し側のアプリケーションは、ppavi が参照する配列内に、ストリームのインターフェイスポインターを渡す必要があります。

アプリケーションは、AVICOMPRESSOPTIONS 構造体と、これらの構造体へのポインターの配列のためのメモリを割り当てる必要があります。

引数 ppavi には、IAVIStream インターフェイスへのポインターのアドレスが格納されます。

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

各言語での呼び出し定義

// AVIFIL32.dll
#include <windows.h>

INT_PTR AVISaveOptions(
    HWND hwnd,
    DWORD uiFlags,
    INT nStreams,
    IAVIStream** ppavi,
    AVICOMPRESSOPTIONS** plpOptions
);

[DllImport("AVIFIL32.dll", ExactSpelling = true)]
static extern IntPtr AVISaveOptions(
    IntPtr hwnd,   // HWND
    uint uiFlags,   // DWORD
    int nStreams,   // INT
    IntPtr ppavi,   // IAVIStream**
    IntPtr plpOptions   // AVICOMPRESSOPTIONS** in/out
);

<DllImport("AVIFIL32.dll", ExactSpelling:=True)>
Public Shared Function AVISaveOptions(
    hwnd As IntPtr,   ' HWND
    uiFlags As UInteger,   ' DWORD
    nStreams As Integer,   ' INT
    ppavi As IntPtr,   ' IAVIStream**
    plpOptions As IntPtr   ' AVICOMPRESSOPTIONS** in/out
) As IntPtr
End Function

' hwnd : HWND
' uiFlags : DWORD
' nStreams : INT
' ppavi : IAVIStream**
' plpOptions : AVICOMPRESSOPTIONS** in/out
Declare PtrSafe Function AVISaveOptions Lib "avifil32" ( _
    ByVal hwnd As LongPtr, _
    ByVal uiFlags As Long, _
    ByVal nStreams As Long, _
    ByVal ppavi As LongPtr, _
    ByVal plpOptions As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

AVISaveOptions = ctypes.windll.avifil32.AVISaveOptions
AVISaveOptions.restype = ctypes.c_ssize_t
AVISaveOptions.argtypes = [
    wintypes.HANDLE,  # hwnd : HWND
    wintypes.DWORD,  # uiFlags : DWORD
    ctypes.c_int,  # nStreams : INT
    ctypes.c_void_p,  # ppavi : IAVIStream**
    ctypes.c_void_p,  # plpOptions : AVICOMPRESSOPTIONS** in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('AVIFIL32.dll')
AVISaveOptions = Fiddle::Function.new(
  lib['AVISaveOptions'],
  [
    Fiddle::TYPE_VOIDP,  # hwnd : HWND
    -Fiddle::TYPE_INT,  # uiFlags : DWORD
    Fiddle::TYPE_INT,  # nStreams : INT
    Fiddle::TYPE_VOIDP,  # ppavi : IAVIStream**
    Fiddle::TYPE_VOIDP,  # plpOptions : AVICOMPRESSOPTIONS** in/out
  ],
  Fiddle::TYPE_INTPTR_T)

#[link(name = "avifil32")]
extern "system" {
    fn AVISaveOptions(
        hwnd: *mut core::ffi::c_void,  // HWND
        uiFlags: u32,  // DWORD
        nStreams: i32,  // INT
        ppavi: *mut *mut core::ffi::c_void,  // IAVIStream**
        plpOptions: *mut *mut AVICOMPRESSOPTIONS  // AVICOMPRESSOPTIONS** in/out
    ) -> isize;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("AVIFIL32.dll")]
public static extern IntPtr AVISaveOptions(IntPtr hwnd, uint uiFlags, int nStreams, IntPtr ppavi, IntPtr plpOptions);
"@
$api = Add-Type -MemberDefinition $sig -Name 'AVIFIL32_AVISaveOptions' -Namespace Win32 -PassThru
# $api::AVISaveOptions(hwnd, uiFlags, nStreams, ppavi, plpOptions)

#uselib "AVIFIL32.dll"
#func global AVISaveOptions "AVISaveOptions" sptr, sptr, sptr, sptr, sptr
; AVISaveOptions hwnd, uiFlags, nStreams, ppavi, varptr(plpOptions)   ; 戻り値は stat
; hwnd : HWND -> "sptr"
; uiFlags : DWORD -> "sptr"
; nStreams : INT -> "sptr"
; ppavi : IAVIStream** -> "sptr"
; plpOptions : AVICOMPRESSOPTIONS** in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "AVIFIL32.dll"
#cfunc global AVISaveOptions "AVISaveOptions" sptr, int, int, sptr, var
; res = AVISaveOptions(hwnd, uiFlags, nStreams, ppavi, plpOptions)
; hwnd : HWND -> "sptr"
; uiFlags : DWORD -> "int"
; nStreams : INT -> "int"
; ppavi : IAVIStream** -> "sptr"
; plpOptions : AVICOMPRESSOPTIONS** in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "AVIFIL32.dll"
#cfunc global AVISaveOptions "AVISaveOptions" sptr, int, int, sptr, sptr
; res = AVISaveOptions(hwnd, uiFlags, nStreams, ppavi, varptr(plpOptions))
; hwnd : HWND -> "sptr"
; uiFlags : DWORD -> "int"
; nStreams : INT -> "int"
; ppavi : IAVIStream** -> "sptr"
; plpOptions : AVICOMPRESSOPTIONS** in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。