Win32 API 日本語リファレンス
ホームMedia.Multimedia › mmioSetBuffer

mmioSetBuffer

関数
MMIOファイルにI/Oバッファを設定または変更する。
DLLWINMM.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD mmioSetBuffer(
    HMMIO hmmio,
    LPSTR pchBuffer,   // optional
    INT cchBuffer,
    DWORD fuBuffer
);

パラメーター

名前方向説明
hmmioHMMIOinファイルのファイルハンドル。
pchBufferLPSTRoutoptionalバッファ付き I/O に使用する、アプリケーション定義のバッファへのポインター。このパラメーターが NULL の場合、mmioSetBuffer はバッファ付き I/O 用に内部バッファを割り当てます。
cchBufferINTinアプリケーション定義のバッファのサイズ(文字数単位)、または mmioSetBuffer が割り当てるバッファのサイズ。
fuBufferDWORDin予約済み。ゼロである必要があります。

戻り値の型: DWORD

公式ドキュメント

mmioSetBuffer 関数は、バッファ付き I/O を有効または無効にし、あるいは mmioOpen 関数を使用して開いたファイルのバッファまたはバッファサイズを変更します。

戻り値

成功した場合はゼロを、それ以外の場合はエラーを返します。エラーが発生した場合でも、ファイルハンドルは有効なままです。次の値が定義されています。

戻り値 説明
MMIOERR_CANNOTWRITE
古いバッファの内容をディスクに書き込めなかったため、操作は中止されました。
MMIOERR_OUTOFMEMORY
新しいバッファを割り当てられませんでした。おそらく利用可能なメモリが不足しているためです。

解説(Remarks)

内部バッファを使用してバッファリングを有効にするには、pchBufferNULL に、cchBuffer を希望するバッファサイズに設定します。

独自のバッファを指定するには、pchBuffer をバッファを指すように設定し、cchBuffer をそのバッファのサイズに設定します。

バッファ付き I/O を無効にするには、pchBufferNULL に、cchBuffer をゼロに設定します。

既に内部バッファを使用してバッファ付き I/O が有効になっている場合は、pchBufferNULL に、cchBuffer を新しいバッファサイズに設定することで、バッファを別のサイズに再割り当てできます。バッファの内容はサイズ変更後に変更できます。

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

各言語での呼び出し定義

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

DWORD mmioSetBuffer(
    HMMIO hmmio,
    LPSTR pchBuffer,   // optional
    INT cchBuffer,
    DWORD fuBuffer
);
[DllImport("WINMM.dll", ExactSpelling = true)]
static extern uint mmioSetBuffer(
    IntPtr hmmio,   // HMMIO
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pchBuffer,   // LPSTR optional, out
    int cchBuffer,   // INT
    uint fuBuffer   // DWORD
);
<DllImport("WINMM.dll", ExactSpelling:=True)>
Public Shared Function mmioSetBuffer(
    hmmio As IntPtr,   ' HMMIO
    <MarshalAs(UnmanagedType.LPStr)> pchBuffer As System.Text.StringBuilder,   ' LPSTR optional, out
    cchBuffer As Integer,   ' INT
    fuBuffer As UInteger   ' DWORD
) As UInteger
End Function
' hmmio : HMMIO
' pchBuffer : LPSTR optional, out
' cchBuffer : INT
' fuBuffer : DWORD
Declare PtrSafe Function mmioSetBuffer Lib "winmm" ( _
    ByVal hmmio As LongPtr, _
    ByVal pchBuffer As String, _
    ByVal cchBuffer As Long, _
    ByVal fuBuffer As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

mmioSetBuffer = ctypes.windll.winmm.mmioSetBuffer
mmioSetBuffer.restype = wintypes.DWORD
mmioSetBuffer.argtypes = [
    wintypes.HANDLE,  # hmmio : HMMIO
    wintypes.LPSTR,  # pchBuffer : LPSTR optional, out
    ctypes.c_int,  # cchBuffer : INT
    wintypes.DWORD,  # fuBuffer : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINMM.dll')
mmioSetBuffer = Fiddle::Function.new(
  lib['mmioSetBuffer'],
  [
    Fiddle::TYPE_VOIDP,  # hmmio : HMMIO
    Fiddle::TYPE_VOIDP,  # pchBuffer : LPSTR optional, out
    Fiddle::TYPE_INT,  # cchBuffer : INT
    -Fiddle::TYPE_INT,  # fuBuffer : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "winmm")]
extern "system" {
    fn mmioSetBuffer(
        hmmio: *mut core::ffi::c_void,  // HMMIO
        pchBuffer: *mut u8,  // LPSTR optional, out
        cchBuffer: i32,  // INT
        fuBuffer: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WINMM.dll")]
public static extern uint mmioSetBuffer(IntPtr hmmio, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pchBuffer, int cchBuffer, uint fuBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINMM_mmioSetBuffer' -Namespace Win32 -PassThru
# $api::mmioSetBuffer(hmmio, pchBuffer, cchBuffer, fuBuffer)
#uselib "WINMM.dll"
#func global mmioSetBuffer "mmioSetBuffer" sptr, sptr, sptr, sptr
; mmioSetBuffer hmmio, varptr(pchBuffer), cchBuffer, fuBuffer   ; 戻り値は stat
; hmmio : HMMIO -> "sptr"
; pchBuffer : LPSTR optional, out -> "sptr"
; cchBuffer : INT -> "sptr"
; fuBuffer : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WINMM.dll"
#cfunc global mmioSetBuffer "mmioSetBuffer" sptr, var, int, int
; res = mmioSetBuffer(hmmio, pchBuffer, cchBuffer, fuBuffer)
; hmmio : HMMIO -> "sptr"
; pchBuffer : LPSTR optional, out -> "var"
; cchBuffer : INT -> "int"
; fuBuffer : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD mmioSetBuffer(HMMIO hmmio, LPSTR pchBuffer, INT cchBuffer, DWORD fuBuffer)
#uselib "WINMM.dll"
#cfunc global mmioSetBuffer "mmioSetBuffer" intptr, var, int, int
; res = mmioSetBuffer(hmmio, pchBuffer, cchBuffer, fuBuffer)
; hmmio : HMMIO -> "intptr"
; pchBuffer : LPSTR optional, out -> "var"
; cchBuffer : INT -> "int"
; fuBuffer : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winmm = windows.NewLazySystemDLL("WINMM.dll")
	procmmioSetBuffer = winmm.NewProc("mmioSetBuffer")
)

// hmmio (HMMIO), pchBuffer (LPSTR optional, out), cchBuffer (INT), fuBuffer (DWORD)
r1, _, err := procmmioSetBuffer.Call(
	uintptr(hmmio),
	uintptr(pchBuffer),
	uintptr(cchBuffer),
	uintptr(fuBuffer),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function mmioSetBuffer(
  hmmio: THandle;   // HMMIO
  pchBuffer: PAnsiChar;   // LPSTR optional, out
  cchBuffer: Integer;   // INT
  fuBuffer: DWORD   // DWORD
): DWORD; stdcall;
  external 'WINMM.dll' name 'mmioSetBuffer';
result := DllCall("WINMM\mmioSetBuffer"
    , "Ptr", hmmio   ; HMMIO
    , "Ptr", pchBuffer   ; LPSTR optional, out
    , "Int", cchBuffer   ; INT
    , "UInt", fuBuffer   ; DWORD
    , "UInt")   ; return: DWORD
●mmioSetBuffer(hmmio, pchBuffer, cchBuffer, fuBuffer) = DLL("WINMM.dll", "dword mmioSetBuffer(void*, char*, int, dword)")
# 呼び出し: mmioSetBuffer(hmmio, pchBuffer, cchBuffer, fuBuffer)
# hmmio : HMMIO -> "void*"
# pchBuffer : LPSTR optional, out -> "char*"
# cchBuffer : INT -> "int"
# fuBuffer : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "winmm" fn mmioSetBuffer(
    hmmio: ?*anyopaque, // HMMIO
    pchBuffer: [*c]u8, // LPSTR optional, out
    cchBuffer: i32, // INT
    fuBuffer: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
proc mmioSetBuffer(
    hmmio: pointer,  # HMMIO
    pchBuffer: ptr char,  # LPSTR optional, out
    cchBuffer: int32,  # INT
    fuBuffer: uint32  # DWORD
): uint32 {.importc: "mmioSetBuffer", stdcall, dynlib: "WINMM.dll".}
pragma(lib, "winmm");
extern(Windows)
uint mmioSetBuffer(
    void* hmmio,   // HMMIO
    char* pchBuffer,   // LPSTR optional, out
    int cchBuffer,   // INT
    uint fuBuffer   // DWORD
);
ccall((:mmioSetBuffer, "WINMM.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Ptr{UInt8}, Int32, UInt32),
      hmmio, pchBuffer, cchBuffer, fuBuffer)
# hmmio : HMMIO -> Ptr{Cvoid}
# pchBuffer : LPSTR optional, out -> Ptr{UInt8}
# cchBuffer : INT -> Int32
# fuBuffer : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t mmioSetBuffer(
    void* hmmio,
    char* pchBuffer,
    int32_t cchBuffer,
    uint32_t fuBuffer);
]]
local winmm = ffi.load("winmm")
-- winmm.mmioSetBuffer(hmmio, pchBuffer, cchBuffer, fuBuffer)
-- hmmio : HMMIO
-- pchBuffer : LPSTR optional, out
-- cchBuffer : INT
-- fuBuffer : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WINMM.dll');
const mmioSetBuffer = lib.func('__stdcall', 'mmioSetBuffer', 'uint32_t', ['void *', 'char *', 'int32_t', 'uint32_t']);
// mmioSetBuffer(hmmio, pchBuffer, cchBuffer, fuBuffer)
// hmmio : HMMIO -> 'void *'
// pchBuffer : LPSTR optional, out -> 'char *'
// cchBuffer : INT -> 'int32_t'
// fuBuffer : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINMM.dll", {
  mmioSetBuffer: { parameters: ["pointer", "buffer", "i32", "u32"], result: "u32" },
});
// lib.symbols.mmioSetBuffer(hmmio, pchBuffer, cchBuffer, fuBuffer)
// hmmio : HMMIO -> "pointer"
// pchBuffer : LPSTR optional, out -> "buffer"
// cchBuffer : INT -> "i32"
// fuBuffer : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t mmioSetBuffer(
    void* hmmio,
    char* pchBuffer,
    int32_t cchBuffer,
    uint32_t fuBuffer);
C, "WINMM.dll");
// $ffi->mmioSetBuffer(hmmio, pchBuffer, cchBuffer, fuBuffer);
// hmmio : HMMIO
// pchBuffer : LPSTR optional, out
// cchBuffer : INT
// fuBuffer : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Winmm extends StdCallLibrary {
    Winmm INSTANCE = Native.load("winmm", Winmm.class);
    int mmioSetBuffer(
        Pointer hmmio,   // HMMIO
        byte[] pchBuffer,   // LPSTR optional, out
        int cchBuffer,   // INT
        int fuBuffer   // DWORD
    );
}
@[Link("winmm")]
lib LibWINMM
  fun mmioSetBuffer = mmioSetBuffer(
    hmmio : Void*,   # HMMIO
    pchBuffer : UInt8*,   # LPSTR optional, out
    cchBuffer : Int32,   # INT
    fuBuffer : UInt32   # DWORD
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef mmioSetBufferNative = Uint32 Function(Pointer<Void>, Pointer<Utf8>, Int32, Uint32);
typedef mmioSetBufferDart = int Function(Pointer<Void>, Pointer<Utf8>, int, int);
final mmioSetBuffer = DynamicLibrary.open('WINMM.dll')
    .lookupFunction<mmioSetBufferNative, mmioSetBufferDart>('mmioSetBuffer');
// hmmio : HMMIO -> Pointer<Void>
// pchBuffer : LPSTR optional, out -> Pointer<Utf8>
// cchBuffer : INT -> Int32
// fuBuffer : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function mmioSetBuffer(
  hmmio: THandle;   // HMMIO
  pchBuffer: PAnsiChar;   // LPSTR optional, out
  cchBuffer: Integer;   // INT
  fuBuffer: DWORD   // DWORD
): DWORD; stdcall;
  external 'WINMM.dll' name 'mmioSetBuffer';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "mmioSetBuffer"
  c_mmioSetBuffer :: Ptr () -> CString -> Int32 -> Word32 -> IO Word32
-- hmmio : HMMIO -> Ptr ()
-- pchBuffer : LPSTR optional, out -> CString
-- cchBuffer : INT -> Int32
-- fuBuffer : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let mmiosetbuffer =
  foreign "mmioSetBuffer"
    ((ptr void) @-> string @-> int32_t @-> uint32_t @-> returning uint32_t)
(* hmmio : HMMIO -> (ptr void) *)
(* pchBuffer : LPSTR optional, out -> string *)
(* cchBuffer : INT -> int32_t *)
(* fuBuffer : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winmm (t "WINMM.dll"))
(cffi:use-foreign-library winmm)

(cffi:defcfun ("mmioSetBuffer" mmio-set-buffer :convention :stdcall) :uint32
  (hmmio :pointer)   ; HMMIO
  (pch-buffer :pointer)   ; LPSTR optional, out
  (cch-buffer :int32)   ; INT
  (fu-buffer :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $mmioSetBuffer = Win32::API::More->new('WINMM',
    'DWORD mmioSetBuffer(HANDLE hmmio, LPSTR pchBuffer, int cchBuffer, DWORD fuBuffer)');
# my $ret = $mmioSetBuffer->Call($hmmio, $pchBuffer, $cchBuffer, $fuBuffer);
# hmmio : HMMIO -> HANDLE
# pchBuffer : LPSTR optional, out -> LPSTR
# cchBuffer : INT -> int
# fuBuffer : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。