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

mciSetYieldProc

関数
MCIデバイスの待機中に呼ぶイールドプロシージャを設定する。
DLLWINMM.dll呼出規約winapi

シグネチャ

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

BOOL mciSetYieldProc(
    DWORD mciId,
    YIELDPROC fpYieldProc,   // optional
    DWORD dwYieldData
);

パラメーター

名前方向説明
mciIdDWORDinイールドプロシージャを設定する対象のMCIデバイス識別子。
fpYieldProcYIELDPROCinoptional待機中に繰り返し呼ばれるYIELDPROCコールバック。NULL指定で解除する。
dwYieldDataDWORDinコールバックへ渡すアプリ定義データ。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL mciSetYieldProc(
    DWORD mciId,
    YIELDPROC fpYieldProc,   // optional
    DWORD dwYieldData
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINMM.dll", ExactSpelling = true)]
static extern bool mciSetYieldProc(
    uint mciId,   // DWORD
    IntPtr fpYieldProc,   // YIELDPROC optional
    uint dwYieldData   // DWORD
);
<DllImport("WINMM.dll", ExactSpelling:=True)>
Public Shared Function mciSetYieldProc(
    mciId As UInteger,   ' DWORD
    fpYieldProc As IntPtr,   ' YIELDPROC optional
    dwYieldData As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' mciId : DWORD
' fpYieldProc : YIELDPROC optional
' dwYieldData : DWORD
Declare PtrSafe Function mciSetYieldProc Lib "winmm" ( _
    ByVal mciId As Long, _
    ByVal fpYieldProc As LongPtr, _
    ByVal dwYieldData As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

mciSetYieldProc = ctypes.windll.winmm.mciSetYieldProc
mciSetYieldProc.restype = wintypes.BOOL
mciSetYieldProc.argtypes = [
    wintypes.DWORD,  # mciId : DWORD
    ctypes.c_void_p,  # fpYieldProc : YIELDPROC optional
    wintypes.DWORD,  # dwYieldData : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINMM.dll')
mciSetYieldProc = Fiddle::Function.new(
  lib['mciSetYieldProc'],
  [
    -Fiddle::TYPE_INT,  # mciId : DWORD
    Fiddle::TYPE_VOIDP,  # fpYieldProc : YIELDPROC optional
    -Fiddle::TYPE_INT,  # dwYieldData : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "winmm")]
extern "system" {
    fn mciSetYieldProc(
        mciId: u32,  // DWORD
        fpYieldProc: *const core::ffi::c_void,  // YIELDPROC optional
        dwYieldData: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINMM.dll")]
public static extern bool mciSetYieldProc(uint mciId, IntPtr fpYieldProc, uint dwYieldData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINMM_mciSetYieldProc' -Namespace Win32 -PassThru
# $api::mciSetYieldProc(mciId, fpYieldProc, dwYieldData)
#uselib "WINMM.dll"
#func global mciSetYieldProc "mciSetYieldProc" sptr, sptr, sptr
; mciSetYieldProc mciId, fpYieldProc, dwYieldData   ; 戻り値は stat
; mciId : DWORD -> "sptr"
; fpYieldProc : YIELDPROC optional -> "sptr"
; dwYieldData : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WINMM.dll"
#cfunc global mciSetYieldProc "mciSetYieldProc" int, sptr, int
; res = mciSetYieldProc(mciId, fpYieldProc, dwYieldData)
; mciId : DWORD -> "int"
; fpYieldProc : YIELDPROC optional -> "sptr"
; dwYieldData : DWORD -> "int"
; BOOL mciSetYieldProc(DWORD mciId, YIELDPROC fpYieldProc, DWORD dwYieldData)
#uselib "WINMM.dll"
#cfunc global mciSetYieldProc "mciSetYieldProc" int, intptr, int
; res = mciSetYieldProc(mciId, fpYieldProc, dwYieldData)
; mciId : DWORD -> "int"
; fpYieldProc : YIELDPROC optional -> "intptr"
; dwYieldData : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winmm = windows.NewLazySystemDLL("WINMM.dll")
	procmciSetYieldProc = winmm.NewProc("mciSetYieldProc")
)

// mciId (DWORD), fpYieldProc (YIELDPROC optional), dwYieldData (DWORD)
r1, _, err := procmciSetYieldProc.Call(
	uintptr(mciId),
	uintptr(fpYieldProc),
	uintptr(dwYieldData),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function mciSetYieldProc(
  mciId: DWORD;   // DWORD
  fpYieldProc: Pointer;   // YIELDPROC optional
  dwYieldData: DWORD   // DWORD
): BOOL; stdcall;
  external 'WINMM.dll' name 'mciSetYieldProc';
result := DllCall("WINMM\mciSetYieldProc"
    , "UInt", mciId   ; DWORD
    , "Ptr", fpYieldProc   ; YIELDPROC optional
    , "UInt", dwYieldData   ; DWORD
    , "Int")   ; return: BOOL
●mciSetYieldProc(mciId, fpYieldProc, dwYieldData) = DLL("WINMM.dll", "bool mciSetYieldProc(dword, void*, dword)")
# 呼び出し: mciSetYieldProc(mciId, fpYieldProc, dwYieldData)
# mciId : DWORD -> "dword"
# fpYieldProc : YIELDPROC optional -> "void*"
# dwYieldData : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "winmm" fn mciSetYieldProc(
    mciId: u32, // DWORD
    fpYieldProc: ?*anyopaque, // YIELDPROC optional
    dwYieldData: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc mciSetYieldProc(
    mciId: uint32,  # DWORD
    fpYieldProc: pointer,  # YIELDPROC optional
    dwYieldData: uint32  # DWORD
): int32 {.importc: "mciSetYieldProc", stdcall, dynlib: "WINMM.dll".}
pragma(lib, "winmm");
extern(Windows)
int mciSetYieldProc(
    uint mciId,   // DWORD
    void* fpYieldProc,   // YIELDPROC optional
    uint dwYieldData   // DWORD
);
ccall((:mciSetYieldProc, "WINMM.dll"), stdcall, Int32,
      (UInt32, Ptr{Cvoid}, UInt32),
      mciId, fpYieldProc, dwYieldData)
# mciId : DWORD -> UInt32
# fpYieldProc : YIELDPROC optional -> Ptr{Cvoid}
# dwYieldData : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t mciSetYieldProc(
    uint32_t mciId,
    void* fpYieldProc,
    uint32_t dwYieldData);
]]
local winmm = ffi.load("winmm")
-- winmm.mciSetYieldProc(mciId, fpYieldProc, dwYieldData)
-- mciId : DWORD
-- fpYieldProc : YIELDPROC optional
-- dwYieldData : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WINMM.dll');
const mciSetYieldProc = lib.func('__stdcall', 'mciSetYieldProc', 'int32_t', ['uint32_t', 'void *', 'uint32_t']);
// mciSetYieldProc(mciId, fpYieldProc, dwYieldData)
// mciId : DWORD -> 'uint32_t'
// fpYieldProc : YIELDPROC optional -> 'void *'
// dwYieldData : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("WINMM.dll", {
  mciSetYieldProc: { parameters: ["u32", "pointer", "u32"], result: "i32" },
});
// lib.symbols.mciSetYieldProc(mciId, fpYieldProc, dwYieldData)
// mciId : DWORD -> "u32"
// fpYieldProc : YIELDPROC optional -> "pointer"
// dwYieldData : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t mciSetYieldProc(
    uint32_t mciId,
    void* fpYieldProc,
    uint32_t dwYieldData);
C, "WINMM.dll");
// $ffi->mciSetYieldProc(mciId, fpYieldProc, dwYieldData);
// mciId : DWORD
// fpYieldProc : YIELDPROC optional
// dwYieldData : 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);
    boolean mciSetYieldProc(
        int mciId,   // DWORD
        Callback fpYieldProc,   // YIELDPROC optional
        int dwYieldData   // DWORD
    );
}
@[Link("winmm")]
lib LibWINMM
  fun mciSetYieldProc = mciSetYieldProc(
    mciId : UInt32,   # DWORD
    fpYieldProc : Void*,   # YIELDPROC optional
    dwYieldData : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef mciSetYieldProcNative = Int32 Function(Uint32, Pointer<Void>, Uint32);
typedef mciSetYieldProcDart = int Function(int, Pointer<Void>, int);
final mciSetYieldProc = DynamicLibrary.open('WINMM.dll')
    .lookupFunction<mciSetYieldProcNative, mciSetYieldProcDart>('mciSetYieldProc');
// mciId : DWORD -> Uint32
// fpYieldProc : YIELDPROC optional -> Pointer<Void>
// dwYieldData : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function mciSetYieldProc(
  mciId: DWORD;   // DWORD
  fpYieldProc: Pointer;   // YIELDPROC optional
  dwYieldData: DWORD   // DWORD
): BOOL; stdcall;
  external 'WINMM.dll' name 'mciSetYieldProc';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "mciSetYieldProc"
  c_mciSetYieldProc :: Word32 -> Ptr () -> Word32 -> IO CInt
-- mciId : DWORD -> Word32
-- fpYieldProc : YIELDPROC optional -> Ptr ()
-- dwYieldData : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let mcisetyieldproc =
  foreign "mciSetYieldProc"
    (uint32_t @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* mciId : DWORD -> uint32_t *)
(* fpYieldProc : YIELDPROC optional -> (ptr void) *)
(* dwYieldData : 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 ("mciSetYieldProc" mci-set-yield-proc :convention :stdcall) :int32
  (mci-id :uint32)   ; DWORD
  (fp-yield-proc :pointer)   ; YIELDPROC optional
  (dw-yield-data :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $mciSetYieldProc = Win32::API::More->new('WINMM',
    'BOOL mciSetYieldProc(DWORD mciId, LPVOID fpYieldProc, DWORD dwYieldData)');
# my $ret = $mciSetYieldProc->Call($mciId, $fpYieldProc, $dwYieldData);
# mciId : DWORD -> DWORD
# fpYieldProc : YIELDPROC optional -> LPVOID
# dwYieldData : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

使用する型