Win32 API 日本語リファレンス
ホームSystem.Diagnostics.Debug › Beep

Beep

関数
指定した周波数と長さでスピーカーからビープ音を鳴らす。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL Beep(
    DWORD dwFreq,
    DWORD dwDuration
);

パラメーター

名前方向説明
dwFreqDWORDin音の周波数(ヘルツ単位)。このパラメーターは 37 から 32,767(0x25 から 0x7FFF)の範囲でなければなりません。
dwDurationDWORDin音の長さ(ミリ秒単位)。

戻り値の型: BOOL

公式ドキュメント

スピーカーで単純なトーンを生成します。

戻り値

関数が成功した場合、戻り値は 0 以外の値になります。

関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出してください。

解説(Remarks)

かつて、すべての PC は原始的な音を生成するために共通の 8254 プログラマブル インターバル タイマー チップを使用していました。Beep 関数は、そのハードウェアでビープ音を鳴らすために特別に作成されました。

これらの古いシステムでは、ミュートや音量の設定は Beep に影響しません。トーンは常に聞こえます。トーンを消すには、次のコマンドを使用していました。

net stop beep

sc config beep start= disabled

その後、サウンド カードがほぼすべての PC で標準装備となりました。サウンド カードが一般的になるにつれて、メーカーはコンピューターから古いタイマー チップを取り除き始めました。これらのチップはサーバー コンピューターの設計からも除外されました。その結果、チップを持たないコンピューターでは Beep が動作しなくなりました。これは問題ありませんでした。ほとんどの開発者が、8254 チップの代わりに既定のサウンド デバイスを使用する MessageBeep 関数の呼び出しへと移行していたためです。

最終的に、通信するハードウェアが存在しないことから、マザーボードのスピーカーからの音の再生のサポートは Windows Vista および Windows XP 64-Bit Edition で廃止されました。

Windows 7 では、Beep はセッションの既定のサウンド デバイスにビープ音を渡すように書き直されました。これは通常サウンド カードですが、ターミナル サービス上で実行される場合は例外で、その場合ビープ音はクライアント側で再生されます。

次の例は、この関数の使用方法を示しています。

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

各言語での呼び出し定義

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

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

Beep = ctypes.windll.kernel32.Beep
Beep.restype = wintypes.BOOL
Beep.argtypes = [
    wintypes.DWORD,  # dwFreq : DWORD
    wintypes.DWORD,  # dwDuration : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procBeep = kernel32.NewProc("Beep")
)

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

extern "kernel32" fn Beep(
    dwFreq: u32, // DWORD
    dwDuration: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc Beep(
    dwFreq: uint32,  # DWORD
    dwDuration: uint32  # DWORD
): int32 {.importc: "Beep", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int Beep(
    uint dwFreq,   // DWORD
    uint dwDuration   // DWORD
);
ccall((:Beep, "KERNEL32.dll"), stdcall, Int32,
      (UInt32, UInt32),
      dwFreq, dwDuration)
# dwFreq : DWORD -> UInt32
# dwDuration : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t Beep(
    uint32_t dwFreq,
    uint32_t dwDuration);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.Beep(dwFreq, dwDuration)
-- dwFreq : DWORD
-- dwDuration : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const Beep = lib.func('__stdcall', 'Beep', 'int32_t', ['uint32_t', 'uint32_t']);
// Beep(dwFreq, dwDuration)
// dwFreq : DWORD -> 'uint32_t'
// dwDuration : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  Beep: { parameters: ["u32", "u32"], result: "i32" },
});
// lib.symbols.Beep(dwFreq, dwDuration)
// dwFreq : DWORD -> "u32"
// dwDuration : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t Beep(
    uint32_t dwFreq,
    uint32_t dwDuration);
C, "KERNEL32.dll");
// $ffi->Beep(dwFreq, dwDuration);
// dwFreq : DWORD
// dwDuration : 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 Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    boolean Beep(
        int dwFreq,   // DWORD
        int dwDuration   // DWORD
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun Beep = Beep(
    dwFreq : UInt32,   # DWORD
    dwDuration : 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 BeepNative = Int32 Function(Uint32, Uint32);
typedef BeepDart = int Function(int, int);
final Beep = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<BeepNative, BeepDart>('Beep');
// dwFreq : DWORD -> Uint32
// dwDuration : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function Beep(
  dwFreq: DWORD;   // DWORD
  dwDuration: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'Beep';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "Beep"
  c_Beep :: Word32 -> Word32 -> IO CInt
-- dwFreq : DWORD -> Word32
-- dwDuration : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let beep =
  foreign "Beep"
    (uint32_t @-> uint32_t @-> returning int32_t)
(* dwFreq : DWORD -> uint32_t *)
(* dwDuration : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("Beep" beep :convention :stdcall) :int32
  (dw-freq :uint32)   ; DWORD
  (dw-duration :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $Beep = Win32::API::More->new('KERNEL32',
    'BOOL Beep(DWORD dwFreq, DWORD dwDuration)');
# my $ret = $Beep->Call($dwFreq, $dwDuration);
# dwFreq : DWORD -> DWORD
# dwDuration : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目