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

mixerGetLineControlsW

関数
ミキサーラインに関連するコントロール情報を取得する(Unicode版)。
DLLWINMM.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD mixerGetLineControlsW(
    HMIXEROBJ hmxobj,   // optional
    MIXERLINECONTROLSW* pmxlc,
    DWORD fdwControls
);

パラメーター

名前方向説明
hmxobjHMIXEROBJinoptional照会対象となるミキサーデバイスオブジェクトのハンドルです。
pmxlcMIXERLINECONTROLSW*inoutMIXERLINECONTROLS 構造体へのポインターです。この構造体は、オーディオラインに関連付けられたコントロールの情報で埋められる 1 つ以上の MIXERCONTROL 構造体を参照するために使用されます。MIXERLINECONTROLS 構造体の cbStruct メンバーは、常に MIXERLINECONTROLS 構造体のサイズ(バイト単位)に初期化されている必要があります。
fdwControlsDWORDin

オーディオラインに関連付けられた 1 つ以上のコントロールに関する情報を取得するためのフラグです。次の値が定義されています。

意味
MIXER_GETLINECONTROLSF_ALL pmxlc パラメーターは、MIXERLINECONTROLS 構造体の dwLineID メンバーで識別されるオーディオラインに関連付けられたすべてのコントロールの情報を受け取る MIXERCONTROL 構造体のリストを参照します。cControls メンバーは、ラインに関連付けられたコントロールの数に初期化する必要があります。この数は、mixerGetLineInfo 関数が返す MIXERLINE 構造体の cControls メンバーから取得します。cbmxctrl メンバーは、単一の MIXERCONTROL 構造体のサイズ(バイト単位)に初期化する必要があります。pamxctrl メンバーは、最初に埋められる MIXERCONTROL 構造体を指している必要があります。このクエリでは dwControlID および dwControlType メンバーは無視されます。
MIXER_GETLINECONTROLSF_ONEBYID pmxlc パラメーターは、MIXERLINECONTROLS 構造体の dwControlID メンバーで識別されるコントロールの情報を受け取る単一の MIXERCONTROL 構造体を参照します。cControls メンバーは 1 に初期化する必要があります。cbmxctrl メンバーは、単一の MIXERCONTROL 構造体のサイズ(バイト単位)に初期化する必要があります。pamxctrl メンバーは、埋められる MIXERCONTROL 構造体を指している必要があります。このクエリでは dwLineID および dwControlType メンバーは無視されます。このクエリは通常、ユーザー定義のコールバック(mixerOpen を参照)が MM_MIXM_CONTROL_CHANGE コントロール変更通知メッセージを受け取った後に、コントロールを更新するために使用されます。
MIXER_GETLINECONTROLSF_ONEBYTYPE mixerGetLineControls 関数は、照会対象のオーディオラインについて、特定のクラスの最初のコントロールに関する情報を取得します。pmxlc パラメーターは、その特定のコントロールに関する情報を受け取る単一の MIXERCONTROL 構造体を参照します。オーディオラインは dwLineID メンバーで識別されます。コントロールのクラスは、MIXERLINECONTROLS 構造体の dwControlType メンバーで指定します。このクエリでは dwControlID メンバーは無視されます。このクエリは、ラインに関連付けられた単一のコントロールの情報を取得するためにアプリケーションで使用できます。たとえば、波形オーディオ出力ラインからピークメーターのみを使用したい場合などに利用できます。
MIXER_OBJECTF_AUX hmxobj パラメーターは、補助デバイス識別子であり、auxGetNumDevs 関数が返すデバイス数より 1 小さい値から 0 までの範囲の値です。
MIXER_OBJECTF_HMIDIIN hmxobj パラメーターは、MIDI 入力デバイスのハンドルです。このハンドルは midiInOpen 関数によって返されたものである必要があります。
MIXER_OBJECTF_HMIDIOUT hmxobj パラメーターは、MIDI 出力デバイスのハンドルです。このハンドルは midiOutOpen 関数によって返されたものである必要があります。
MIXER_OBJECTF_HMIXER hmxobj パラメーターは、mixerOpen 関数が返すミキサーデバイスハンドルです。このフラグは省略可能です。
MIXER_OBJECTF_HWAVEIN hmxobj パラメーターは、waveInOpen 関数が返す波形オーディオ入力ハンドルです。
MIXER_OBJECTF_HWAVEOUT hmxobj パラメーターは、waveOutOpen 関数が返す波形オーディオ出力ハンドルです。
MIXER_OBJECTF_MIDIIN hmxobj パラメーターは、MIDI 入力デバイスの識別子です。この識別子は、midiInGetNumDevs 関数が返すデバイス数より 1 小さい値から 0 までの範囲内である必要があります。
MIXER_OBJECTF_MIDIOUT hmxobj パラメーターは、MIDI 出力デバイスの識別子です。この識別子は、midiOutGetNumDevs 関数が返すデバイス数より 1 小さい値から 0 までの範囲内である必要があります。
MIXER_OBJECTF_MIXER hmxobj パラメーターは、ミキサーデバイスの識別子であり、mixerGetNumDevs 関数が返すデバイス数より 1 小さい値から 0 までの範囲の値です。このフラグは省略可能です。
MIXER_OBJECTF_WAVEIN hmxobj パラメーターは、波形オーディオ入力デバイスの識別子であり、waveInGetNumDevs 関数が返すデバイス数より 1 小さい値から 0 までの範囲の値です。
MIXER_OBJECTF_WAVEOUT hmxobj パラメーターは、波形オーディオ出力デバイスの識別子であり、waveOutGetNumDevs 関数が返すデバイス数より 1 小さい値から 0 までの範囲の値です。

戻り値の型: DWORD

公式ドキュメント

mixerGetLineControlsW (Unicode) 関数は、オーディオラインに関連付けられた 1 つ以上のコントロールを取得します。(mixerGetLineControlsW)

戻り値

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

戻り値 説明
MIXERR_INVALCONTROL
コントロールの参照が無効です。
MIXERR_INVALLINE
オーディオラインの参照が無効です。
MMSYSERR_BADDEVICEID
hmxobj パラメーターが無効なデバイス識別子を指定しています。
MMSYSERR_INVALFLAG
1 つ以上のフラグが無効です。
MMSYSERR_INVALHANDLE
hmxobj パラメーターが無効なハンドルを指定しています。
MMSYSERR_INVALPARAM
1 つ以上のパラメーターが無効です。
MMSYSERR_NODRIVER
hmxobj で指定されたオブジェクトに対して使用可能なミキサーデバイスがありません。

解説(Remarks)

メモ

mmeapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして mixerGetLineControls を定義します。エンコーディングに依存しないエイリアスの使用を、エンコーディングに依存しないわけではないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、「Conventions for Function Prototypes」を参照してください。

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

各言語での呼び出し定義

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

DWORD mixerGetLineControlsW(
    HMIXEROBJ hmxobj,   // optional
    MIXERLINECONTROLSW* pmxlc,
    DWORD fdwControls
);
[DllImport("WINMM.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint mixerGetLineControlsW(
    IntPtr hmxobj,   // HMIXEROBJ optional
    IntPtr pmxlc,   // MIXERLINECONTROLSW* in/out
    uint fdwControls   // DWORD
);
<DllImport("WINMM.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function mixerGetLineControlsW(
    hmxobj As IntPtr,   ' HMIXEROBJ optional
    pmxlc As IntPtr,   ' MIXERLINECONTROLSW* in/out
    fdwControls As UInteger   ' DWORD
) As UInteger
End Function
' hmxobj : HMIXEROBJ optional
' pmxlc : MIXERLINECONTROLSW* in/out
' fdwControls : DWORD
Declare PtrSafe Function mixerGetLineControlsW Lib "winmm" ( _
    ByVal hmxobj As LongPtr, _
    ByVal pmxlc As LongPtr, _
    ByVal fdwControls 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

mixerGetLineControlsW = ctypes.windll.winmm.mixerGetLineControlsW
mixerGetLineControlsW.restype = wintypes.DWORD
mixerGetLineControlsW.argtypes = [
    wintypes.HANDLE,  # hmxobj : HMIXEROBJ optional
    ctypes.c_void_p,  # pmxlc : MIXERLINECONTROLSW* in/out
    wintypes.DWORD,  # fdwControls : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	winmm = windows.NewLazySystemDLL("WINMM.dll")
	procmixerGetLineControlsW = winmm.NewProc("mixerGetLineControlsW")
)

// hmxobj (HMIXEROBJ optional), pmxlc (MIXERLINECONTROLSW* in/out), fdwControls (DWORD)
r1, _, err := procmixerGetLineControlsW.Call(
	uintptr(hmxobj),
	uintptr(pmxlc),
	uintptr(fdwControls),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function mixerGetLineControlsW(
  hmxobj: THandle;   // HMIXEROBJ optional
  pmxlc: Pointer;   // MIXERLINECONTROLSW* in/out
  fdwControls: DWORD   // DWORD
): DWORD; stdcall;
  external 'WINMM.dll' name 'mixerGetLineControlsW';
result := DllCall("WINMM\mixerGetLineControlsW"
    , "Ptr", hmxobj   ; HMIXEROBJ optional
    , "Ptr", pmxlc   ; MIXERLINECONTROLSW* in/out
    , "UInt", fdwControls   ; DWORD
    , "UInt")   ; return: DWORD
●mixerGetLineControlsW(hmxobj, pmxlc, fdwControls) = DLL("WINMM.dll", "dword mixerGetLineControlsW(void*, void*, dword)")
# 呼び出し: mixerGetLineControlsW(hmxobj, pmxlc, fdwControls)
# hmxobj : HMIXEROBJ optional -> "void*"
# pmxlc : MIXERLINECONTROLSW* in/out -> "void*"
# fdwControls : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "winmm" fn mixerGetLineControlsW(
    hmxobj: ?*anyopaque, // HMIXEROBJ optional
    pmxlc: [*c]MIXERLINECONTROLSW, // MIXERLINECONTROLSW* in/out
    fdwControls: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc mixerGetLineControlsW(
    hmxobj: pointer,  # HMIXEROBJ optional
    pmxlc: ptr MIXERLINECONTROLSW,  # MIXERLINECONTROLSW* in/out
    fdwControls: uint32  # DWORD
): uint32 {.importc: "mixerGetLineControlsW", stdcall, dynlib: "WINMM.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "winmm");
extern(Windows)
uint mixerGetLineControlsW(
    void* hmxobj,   // HMIXEROBJ optional
    MIXERLINECONTROLSW* pmxlc,   // MIXERLINECONTROLSW* in/out
    uint fdwControls   // DWORD
);
ccall((:mixerGetLineControlsW, "WINMM.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Ptr{MIXERLINECONTROLSW}, UInt32),
      hmxobj, pmxlc, fdwControls)
# hmxobj : HMIXEROBJ optional -> Ptr{Cvoid}
# pmxlc : MIXERLINECONTROLSW* in/out -> Ptr{MIXERLINECONTROLSW}
# fdwControls : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t mixerGetLineControlsW(
    void* hmxobj,
    void* pmxlc,
    uint32_t fdwControls);
]]
local winmm = ffi.load("winmm")
-- winmm.mixerGetLineControlsW(hmxobj, pmxlc, fdwControls)
-- hmxobj : HMIXEROBJ optional
-- pmxlc : MIXERLINECONTROLSW* in/out
-- fdwControls : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('WINMM.dll');
const mixerGetLineControlsW = lib.func('__stdcall', 'mixerGetLineControlsW', 'uint32_t', ['void *', 'void *', 'uint32_t']);
// mixerGetLineControlsW(hmxobj, pmxlc, fdwControls)
// hmxobj : HMIXEROBJ optional -> 'void *'
// pmxlc : MIXERLINECONTROLSW* in/out -> 'void *'
// fdwControls : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINMM.dll", {
  mixerGetLineControlsW: { parameters: ["pointer", "pointer", "u32"], result: "u32" },
});
// lib.symbols.mixerGetLineControlsW(hmxobj, pmxlc, fdwControls)
// hmxobj : HMIXEROBJ optional -> "pointer"
// pmxlc : MIXERLINECONTROLSW* in/out -> "pointer"
// fdwControls : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t mixerGetLineControlsW(
    void* hmxobj,
    void* pmxlc,
    uint32_t fdwControls);
C, "WINMM.dll");
// $ffi->mixerGetLineControlsW(hmxobj, pmxlc, fdwControls);
// hmxobj : HMIXEROBJ optional
// pmxlc : MIXERLINECONTROLSW* in/out
// fdwControls : 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, W32APIOptions.UNICODE_OPTIONS);
    int mixerGetLineControlsW(
        Pointer hmxobj,   // HMIXEROBJ optional
        Pointer pmxlc,   // MIXERLINECONTROLSW* in/out
        int fdwControls   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("winmm")]
lib LibWINMM
  fun mixerGetLineControlsW = mixerGetLineControlsW(
    hmxobj : Void*,   # HMIXEROBJ optional
    pmxlc : MIXERLINECONTROLSW*,   # MIXERLINECONTROLSW* in/out
    fdwControls : 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 mixerGetLineControlsWNative = Uint32 Function(Pointer<Void>, Pointer<Void>, Uint32);
typedef mixerGetLineControlsWDart = int Function(Pointer<Void>, Pointer<Void>, int);
final mixerGetLineControlsW = DynamicLibrary.open('WINMM.dll')
    .lookupFunction<mixerGetLineControlsWNative, mixerGetLineControlsWDart>('mixerGetLineControlsW');
// hmxobj : HMIXEROBJ optional -> Pointer<Void>
// pmxlc : MIXERLINECONTROLSW* in/out -> Pointer<Void>
// fdwControls : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function mixerGetLineControlsW(
  hmxobj: THandle;   // HMIXEROBJ optional
  pmxlc: Pointer;   // MIXERLINECONTROLSW* in/out
  fdwControls: DWORD   // DWORD
): DWORD; stdcall;
  external 'WINMM.dll' name 'mixerGetLineControlsW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "mixerGetLineControlsW"
  c_mixerGetLineControlsW :: Ptr () -> Ptr () -> Word32 -> IO Word32
-- hmxobj : HMIXEROBJ optional -> Ptr ()
-- pmxlc : MIXERLINECONTROLSW* in/out -> Ptr ()
-- fdwControls : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let mixergetlinecontrolsw =
  foreign "mixerGetLineControlsW"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> returning uint32_t)
(* hmxobj : HMIXEROBJ optional -> (ptr void) *)
(* pmxlc : MIXERLINECONTROLSW* in/out -> (ptr void) *)
(* fdwControls : 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 ("mixerGetLineControlsW" mixer-get-line-controls-w :convention :stdcall) :uint32
  (hmxobj :pointer)   ; HMIXEROBJ optional
  (pmxlc :pointer)   ; MIXERLINECONTROLSW* in/out
  (fdw-controls :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $mixerGetLineControlsW = Win32::API::More->new('WINMM',
    'DWORD mixerGetLineControlsW(HANDLE hmxobj, LPVOID pmxlc, DWORD fdwControls)');
# my $ret = $mixerGetLineControlsW->Call($hmxobj, $pmxlc, $fdwControls);
# hmxobj : HMIXEROBJ optional -> HANDLE
# pmxlc : MIXERLINECONTROLSW* in/out -> LPVOID
# fdwControls : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
使用する型