Win32 API 日本語リファレンス
ホームMedia.Audio.XAudio2 › CreateFX

CreateFX

関数
指定したCLSIDのXAPOオーディオエフェクトオブジェクトを生成する。
DLLXAudio2_8.dll呼出規約cdecl

シグネチャ

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

HRESULT CreateFX(
    const GUID* clsid,
    IUnknown** pEffect,
    const void* pInitDat,   // optional
    DWORD InitDataByteSize
);

パラメーター

名前方向説明
clsidGUID*in生成するXAPOエフェクトのクラスID(CLSID)を指すGUIDへのポインター。
pEffectIUnknown**out生成されたエフェクトのIUnknownインターフェイスを受け取るポインター。
pInitDatvoid*inoptionalエフェクトへ渡す初期化データへのポインター。不要ならNULL可。
InitDataByteSizeDWORDinpInitDatが指す初期化データのバイトサイズ。データ無しなら0を指定する。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT CreateFX(
    const GUID* clsid,
    IUnknown** pEffect,
    const void* pInitDat,   // optional
    DWORD InitDataByteSize
);
[DllImport("XAudio2_8.dll", ExactSpelling = true, CallingConvention = CallingConvention.Cdecl)]
static extern int CreateFX(
    ref Guid clsid,   // GUID*
    IntPtr pEffect,   // IUnknown** out
    IntPtr pInitDat,   // void* optional
    uint InitDataByteSize   // DWORD
);
<DllImport("XAudio2_8.dll", ExactSpelling:=True, CallingConvention:=CallingConvention.Cdecl)>
Public Shared Function CreateFX(
    ByRef clsid As Guid,   ' GUID*
    pEffect As IntPtr,   ' IUnknown** out
    pInitDat As IntPtr,   ' void* optional
    InitDataByteSize As UInteger   ' DWORD
) As Integer
End Function
' clsid : GUID*
' pEffect : IUnknown** out
' pInitDat : void* optional
' InitDataByteSize : DWORD
Declare PtrSafe Function CreateFX Lib "xaudio2_8" ( _
    ByVal clsid As LongPtr, _
    ByVal pEffect As LongPtr, _
    ByVal pInitDat As LongPtr, _
    ByVal InitDataByteSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CreateFX = ctypes.cdll.xaudio2_8.CreateFX
CreateFX.restype = ctypes.c_int
CreateFX.argtypes = [
    ctypes.c_void_p,  # clsid : GUID*
    ctypes.c_void_p,  # pEffect : IUnknown** out
    ctypes.POINTER(None),  # pInitDat : void* optional
    wintypes.DWORD,  # InitDataByteSize : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('XAudio2_8.dll')
CreateFX = Fiddle::Function.new(
  lib['CreateFX'],
  [
    Fiddle::TYPE_VOIDP,  # clsid : GUID*
    Fiddle::TYPE_VOIDP,  # pEffect : IUnknown** out
    Fiddle::TYPE_VOIDP,  # pInitDat : void* optional
    -Fiddle::TYPE_INT,  # InitDataByteSize : DWORD
  ],
  Fiddle::TYPE_INT, Fiddle::Function::CDECL)
#[link(name = "xaudio2_8")]
extern "C" {
    fn CreateFX(
        clsid: *const GUID,  // GUID*
        pEffect: *mut *mut core::ffi::c_void,  // IUnknown** out
        pInitDat: *const (),  // void* optional
        InitDataByteSize: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("XAudio2_8.dll", CallingConvention = CallingConvention.Cdecl)]
public static extern int CreateFX(ref Guid clsid, IntPtr pEffect, IntPtr pInitDat, uint InitDataByteSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'XAudio2_8_CreateFX' -Namespace Win32 -PassThru
# $api::CreateFX(clsid, pEffect, pInitDat, InitDataByteSize)
#uselib "XAudio2_8.dll"
#func global CreateFX "CreateFX" sptr, sptr, sptr, sptr
; CreateFX varptr(clsid), pEffect, pInitDat, InitDataByteSize   ; 戻り値は stat
; clsid : GUID* -> "sptr"
; pEffect : IUnknown** out -> "sptr"
; pInitDat : void* optional -> "sptr"
; InitDataByteSize : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "XAudio2_8.dll"
#cfunc global CreateFX "CreateFX" var, sptr, sptr, int
; res = CreateFX(clsid, pEffect, pInitDat, InitDataByteSize)
; clsid : GUID* -> "var"
; pEffect : IUnknown** out -> "sptr"
; pInitDat : void* optional -> "sptr"
; InitDataByteSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT CreateFX(GUID* clsid, IUnknown** pEffect, void* pInitDat, DWORD InitDataByteSize)
#uselib "XAudio2_8.dll"
#cfunc global CreateFX "CreateFX" var, intptr, intptr, int
; res = CreateFX(clsid, pEffect, pInitDat, InitDataByteSize)
; clsid : GUID* -> "var"
; pEffect : IUnknown** out -> "intptr"
; pInitDat : void* optional -> "intptr"
; InitDataByteSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	xaudio2_8 = windows.NewLazySystemDLL("XAudio2_8.dll")
	procCreateFX = xaudio2_8.NewProc("CreateFX")
)

// clsid (GUID*), pEffect (IUnknown** out), pInitDat (void* optional), InitDataByteSize (DWORD)
r1, _, err := procCreateFX.Call(
	uintptr(clsid),
	uintptr(pEffect),
	uintptr(pInitDat),
	uintptr(InitDataByteSize),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function CreateFX(
  clsid: PGUID;   // GUID*
  pEffect: Pointer;   // IUnknown** out
  pInitDat: Pointer;   // void* optional
  InitDataByteSize: DWORD   // DWORD
): Integer; cdecl;
  external 'XAudio2_8.dll' name 'CreateFX';
result := DllCall("XAudio2_8\CreateFX"
    , "Ptr", clsid   ; GUID*
    , "Ptr", pEffect   ; IUnknown** out
    , "Ptr", pInitDat   ; void* optional
    , "UInt", InitDataByteSize   ; DWORD
    , "Cdecl Int")   ; return: HRESULT
●CreateFX(clsid, pEffect, pInitDat, InitDataByteSize) = DLL("XAudio2_8.dll", "int CreateFX(void*, void*, void*, dword)")
# 呼び出し: CreateFX(clsid, pEffect, pInitDat, InitDataByteSize)
# clsid : GUID* -> "void*"
# pEffect : IUnknown** out -> "void*"
# pInitDat : void* optional -> "void*"
# InitDataByteSize : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※cdecl関数。DLL()宣言はstdcall前提。cdeclは EXEC_PTR(`cdecl`,…) を使用。
const std = @import("std");

extern "xaudio2_8" fn CreateFX(
    clsid: [*c]GUID, // GUID*
    pEffect: ?*anyopaque, // IUnknown** out
    pInitDat: ?*anyopaque, // void* optional
    InitDataByteSize: u32 // DWORD
) callconv(.c) i32;
proc CreateFX(
    clsid: ptr GUID,  # GUID*
    pEffect: pointer,  # IUnknown** out
    pInitDat: pointer,  # void* optional
    InitDataByteSize: uint32  # DWORD
): int32 {.importc: "CreateFX", cdecl, dynlib: "XAudio2_8.dll".}
pragma(lib, "xaudio2_8");
extern(C)
int CreateFX(
    GUID* clsid,   // GUID*
    void* pEffect,   // IUnknown** out
    void* pInitDat,   // void* optional
    uint InitDataByteSize   // DWORD
);
ccall((:CreateFX, "XAudio2_8.dll"), Int32,
      (Ptr{GUID}, Ptr{Cvoid}, Ptr{Cvoid}, UInt32),
      clsid, pEffect, pInitDat, InitDataByteSize)
# clsid : GUID* -> Ptr{GUID}
# pEffect : IUnknown** out -> Ptr{Cvoid}
# pInitDat : void* optional -> Ptr{Cvoid}
# InitDataByteSize : DWORD -> UInt32
local ffi = require("ffi")
ffi.cdef[[
int32_t CreateFX(
    void* clsid,
    void* pEffect,
    void* pInitDat,
    uint32_t InitDataByteSize);
]]
local xaudio2_8 = ffi.load("xaudio2_8")
-- xaudio2_8.CreateFX(clsid, pEffect, pInitDat, InitDataByteSize)
-- clsid : GUID*
-- pEffect : IUnknown** out
-- pInitDat : void* optional
-- InitDataByteSize : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('XAudio2_8.dll');
const CreateFX = lib.func('__cdecl', 'CreateFX', 'int32_t', ['void *', 'void *', 'void *', 'uint32_t']);
// CreateFX(clsid, pEffect, pInitDat, InitDataByteSize)
// clsid : GUID* -> 'void *'
// pEffect : IUnknown** out -> 'void *'
// pInitDat : void* optional -> 'void *'
// InitDataByteSize : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("XAudio2_8.dll", {
  CreateFX: { parameters: ["pointer", "pointer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.CreateFX(clsid, pEffect, pInitDat, InitDataByteSize)
// clsid : GUID* -> "pointer"
// pEffect : IUnknown** out -> "pointer"
// pInitDat : void* optional -> "pointer"
// InitDataByteSize : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t CreateFX(
    void* clsid,
    void* pEffect,
    void* pInitDat,
    uint32_t InitDataByteSize);
C, "XAudio2_8.dll");
// $ffi->CreateFX(clsid, pEffect, pInitDat, InitDataByteSize);
// clsid : GUID*
// pEffect : IUnknown** out
// pInitDat : void* optional
// InitDataByteSize : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Xaudio2_8 extends Library {
    Xaudio2_8 INSTANCE = Native.load("xaudio2_8", Xaudio2_8.class);
    int CreateFX(
        Pointer clsid,   // GUID*
        Pointer pEffect,   // IUnknown** out
        Pointer pInitDat,   // void* optional
        int InitDataByteSize   // DWORD
    );
}
@[Link("xaudio2_8")]
lib LibXAudio2_8
  fun CreateFX = CreateFX(
    clsid : GUID*,   # GUID*
    pEffect : Void*,   # IUnknown** out
    pInitDat : Void*,   # void* optional
    InitDataByteSize : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CreateFXNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, Uint32);
typedef CreateFXDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, int);
final CreateFX = DynamicLibrary.open('XAudio2_8.dll')
    .lookupFunction<CreateFXNative, CreateFXDart>('CreateFX');
// clsid : GUID* -> Pointer<Void>
// pEffect : IUnknown** out -> Pointer<Void>
// pInitDat : void* optional -> Pointer<Void>
// InitDataByteSize : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CreateFX(
  clsid: PGUID;   // GUID*
  pEffect: Pointer;   // IUnknown** out
  pInitDat: Pointer;   // void* optional
  InitDataByteSize: DWORD   // DWORD
): Integer; cdecl;
  external 'XAudio2_8.dll' name 'CreateFX';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import ccall safe "CreateFX"
  c_CreateFX :: Ptr () -> Ptr () -> Ptr () -> Word32 -> IO Int32
-- clsid : GUID* -> Ptr ()
-- pEffect : IUnknown** out -> Ptr ()
-- pInitDat : void* optional -> Ptr ()
-- InitDataByteSize : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let createfx =
  foreign "CreateFX"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* clsid : GUID* -> (ptr void) *)
(* pEffect : IUnknown** out -> (ptr void) *)
(* pInitDat : void* optional -> (ptr void) *)
(* InitDataByteSize : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library xaudio2_8 (t "XAudio2_8.dll"))
(cffi:use-foreign-library xaudio2_8)

(cffi:defcfun ("CreateFX" create-fx :convention :cdecl) :int32
  (clsid :pointer)   ; GUID*
  (p-effect :pointer)   ; IUnknown** out
  (p-init-dat :pointer)   ; void* optional
  (init-data-byte-size :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CreateFX = Win32::API::More->new('XAudio2_8',
    'int CreateFX(LPVOID clsid, LPVOID pEffect, LPVOID pInitDat, DWORD InitDataByteSize)');
# my $ret = $CreateFX->Call($clsid, $pEffect, $pInitDat, $InitDataByteSize);
# clsid : GUID* -> LPVOID
# pEffect : IUnknown** out -> LPVOID
# pInitDat : void* optional -> LPVOID
# InitDataByteSize : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型