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

midiStreamProperty

関数
MIDIストリームのプロパティを取得または設定する。
DLLWINMM.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD midiStreamProperty(
    HMIDISTRM hms,
    BYTE* lppropdata,
    DWORD dwProperty
);

パラメーター

名前方向説明
hmsHMIDISTRMinプロパティが関連付けられている MIDI デバイスへのハンドル。
lppropdataBYTE*inoutプロパティデータへのポインター。
dwPropertyDWORDin

実行するアクションを指定し、MIDI データストリームの対象プロパティを識別するフラグです。midiStreamProperty 関数は、呼び出しごとに 2 つのフラグを設定する必要があります。一方のフラグ (MIDIPROP_GET または MIDIPROP_SET) はアクションを指定し、もう一方は調査または編集する特定のプロパティを識別します。

説明
MIDIPROP_GET 指定したプロパティの現在の設定を取得します。
MIDIPROP_SET 指定したプロパティを設定します。
MIDIPROP_TEMPO テンポプロパティを取得します。lppropdata パラメーターは MIDIPROPTEMPO 構造体を指します。現在のテンポ値はいつでも取得できます。出力デバイスは、MIDI データに MEVT_TEMPO イベントを挿入することでテンポを設定します。
MIDIPROP_TIMEDIV 時間分解能プロパティを指定します。このプロパティは取得または設定が可能です。lppropdata パラメーターは MIDIPROPTIMEDIV 構造体を指します。このプロパティは、デバイスが停止しているときにのみ設定できます。

戻り値の型: DWORD

公式ドキュメント

midiStreamProperty 関数は、MIDI 出力デバイスに関連付けられた MIDI データストリームのプロパティを設定または取得します。

戻り値

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

戻り値 説明
MMSYSERR_INVALHANDLE
指定したハンドルがストリームハンドルではありません。
MMSYSERR_INVALPARAM
指定したハンドルまたはフラグパラメーターが無効です。

解説(Remarks)

これらのプロパティは、システムによって定義された既定のプロパティです。ドライバー開発者は、独自のプロパティを実装してドキュメント化できます。

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

各言語での呼び出し定義

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

DWORD midiStreamProperty(
    HMIDISTRM hms,
    BYTE* lppropdata,
    DWORD dwProperty
);
[DllImport("WINMM.dll", ExactSpelling = true)]
static extern uint midiStreamProperty(
    IntPtr hms,   // HMIDISTRM
    IntPtr lppropdata,   // BYTE* in/out
    uint dwProperty   // DWORD
);
<DllImport("WINMM.dll", ExactSpelling:=True)>
Public Shared Function midiStreamProperty(
    hms As IntPtr,   ' HMIDISTRM
    lppropdata As IntPtr,   ' BYTE* in/out
    dwProperty As UInteger   ' DWORD
) As UInteger
End Function
' hms : HMIDISTRM
' lppropdata : BYTE* in/out
' dwProperty : DWORD
Declare PtrSafe Function midiStreamProperty Lib "winmm" ( _
    ByVal hms As LongPtr, _
    ByVal lppropdata As LongPtr, _
    ByVal dwProperty As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

midiStreamProperty = ctypes.windll.winmm.midiStreamProperty
midiStreamProperty.restype = wintypes.DWORD
midiStreamProperty.argtypes = [
    wintypes.HANDLE,  # hms : HMIDISTRM
    ctypes.POINTER(ctypes.c_ubyte),  # lppropdata : BYTE* in/out
    wintypes.DWORD,  # dwProperty : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	winmm = windows.NewLazySystemDLL("WINMM.dll")
	procmidiStreamProperty = winmm.NewProc("midiStreamProperty")
)

// hms (HMIDISTRM), lppropdata (BYTE* in/out), dwProperty (DWORD)
r1, _, err := procmidiStreamProperty.Call(
	uintptr(hms),
	uintptr(lppropdata),
	uintptr(dwProperty),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function midiStreamProperty(
  hms: THandle;   // HMIDISTRM
  lppropdata: Pointer;   // BYTE* in/out
  dwProperty: DWORD   // DWORD
): DWORD; stdcall;
  external 'WINMM.dll' name 'midiStreamProperty';
result := DllCall("WINMM\midiStreamProperty"
    , "Ptr", hms   ; HMIDISTRM
    , "Ptr", lppropdata   ; BYTE* in/out
    , "UInt", dwProperty   ; DWORD
    , "UInt")   ; return: DWORD
●midiStreamProperty(hms, lppropdata, dwProperty) = DLL("WINMM.dll", "dword midiStreamProperty(void*, void*, dword)")
# 呼び出し: midiStreamProperty(hms, lppropdata, dwProperty)
# hms : HMIDISTRM -> "void*"
# lppropdata : BYTE* in/out -> "void*"
# dwProperty : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "winmm" fn midiStreamProperty(
    hms: ?*anyopaque, // HMIDISTRM
    lppropdata: [*c]u8, // BYTE* in/out
    dwProperty: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
proc midiStreamProperty(
    hms: pointer,  # HMIDISTRM
    lppropdata: ptr uint8,  # BYTE* in/out
    dwProperty: uint32  # DWORD
): uint32 {.importc: "midiStreamProperty", stdcall, dynlib: "WINMM.dll".}
pragma(lib, "winmm");
extern(Windows)
uint midiStreamProperty(
    void* hms,   // HMIDISTRM
    ubyte* lppropdata,   // BYTE* in/out
    uint dwProperty   // DWORD
);
ccall((:midiStreamProperty, "WINMM.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Ptr{UInt8}, UInt32),
      hms, lppropdata, dwProperty)
# hms : HMIDISTRM -> Ptr{Cvoid}
# lppropdata : BYTE* in/out -> Ptr{UInt8}
# dwProperty : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t midiStreamProperty(
    void* hms,
    uint8_t* lppropdata,
    uint32_t dwProperty);
]]
local winmm = ffi.load("winmm")
-- winmm.midiStreamProperty(hms, lppropdata, dwProperty)
-- hms : HMIDISTRM
-- lppropdata : BYTE* in/out
-- dwProperty : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WINMM.dll');
const midiStreamProperty = lib.func('__stdcall', 'midiStreamProperty', 'uint32_t', ['void *', 'uint8_t *', 'uint32_t']);
// midiStreamProperty(hms, lppropdata, dwProperty)
// hms : HMIDISTRM -> 'void *'
// lppropdata : BYTE* in/out -> 'uint8_t *'
// dwProperty : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINMM.dll", {
  midiStreamProperty: { parameters: ["pointer", "pointer", "u32"], result: "u32" },
});
// lib.symbols.midiStreamProperty(hms, lppropdata, dwProperty)
// hms : HMIDISTRM -> "pointer"
// lppropdata : BYTE* in/out -> "pointer"
// dwProperty : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t midiStreamProperty(
    void* hms,
    uint8_t* lppropdata,
    uint32_t dwProperty);
C, "WINMM.dll");
// $ffi->midiStreamProperty(hms, lppropdata, dwProperty);
// hms : HMIDISTRM
// lppropdata : BYTE* in/out
// dwProperty : 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 midiStreamProperty(
        Pointer hms,   // HMIDISTRM
        byte[] lppropdata,   // BYTE* in/out
        int dwProperty   // DWORD
    );
}
@[Link("winmm")]
lib LibWINMM
  fun midiStreamProperty = midiStreamProperty(
    hms : Void*,   # HMIDISTRM
    lppropdata : UInt8*,   # BYTE* in/out
    dwProperty : 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 midiStreamPropertyNative = Uint32 Function(Pointer<Void>, Pointer<Uint8>, Uint32);
typedef midiStreamPropertyDart = int Function(Pointer<Void>, Pointer<Uint8>, int);
final midiStreamProperty = DynamicLibrary.open('WINMM.dll')
    .lookupFunction<midiStreamPropertyNative, midiStreamPropertyDart>('midiStreamProperty');
// hms : HMIDISTRM -> Pointer<Void>
// lppropdata : BYTE* in/out -> Pointer<Uint8>
// dwProperty : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function midiStreamProperty(
  hms: THandle;   // HMIDISTRM
  lppropdata: Pointer;   // BYTE* in/out
  dwProperty: DWORD   // DWORD
): DWORD; stdcall;
  external 'WINMM.dll' name 'midiStreamProperty';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "midiStreamProperty"
  c_midiStreamProperty :: Ptr () -> Ptr Word8 -> Word32 -> IO Word32
-- hms : HMIDISTRM -> Ptr ()
-- lppropdata : BYTE* in/out -> Ptr Word8
-- dwProperty : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let midistreamproperty =
  foreign "midiStreamProperty"
    ((ptr void) @-> (ptr uint8_t) @-> uint32_t @-> returning uint32_t)
(* hms : HMIDISTRM -> (ptr void) *)
(* lppropdata : BYTE* in/out -> (ptr uint8_t) *)
(* dwProperty : 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 ("midiStreamProperty" midi-stream-property :convention :stdcall) :uint32
  (hms :pointer)   ; HMIDISTRM
  (lppropdata :pointer)   ; BYTE* in/out
  (dw-property :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $midiStreamProperty = Win32::API::More->new('WINMM',
    'DWORD midiStreamProperty(HANDLE hms, LPVOID lppropdata, DWORD dwProperty)');
# my $ret = $midiStreamProperty->Call($hms, $lppropdata, $dwProperty);
# hms : HMIDISTRM -> HANDLE
# lppropdata : BYTE* in/out -> LPVOID
# dwProperty : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。