Win32 API 日本語リファレンス
ホームUI.Input.KeyboardAndMouse › SwapMouseButton

SwapMouseButton

関数
マウスの左右ボタンの機能を入れ替える。
DLLUSER32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL SwapMouseButton(
    BOOL fSwap
);

パラメーター

名前方向説明
fSwapBOOLinこのパラメーターが TRUE の場合、左ボタンは右ボタンのメッセージを生成し、右ボタンは左ボタンのメッセージを生成します。このパラメーターが FALSE の場合、ボタンは元の意味に戻されます。

戻り値の型: BOOL

公式ドキュメント

マウスの左ボタンと右ボタンの意味を入れ替える、または元に戻します。

戻り値

型: BOOL

関数が呼び出される前にマウスボタンの意味がすでに入れ替えられていた場合、戻り値は 0 以外になります。

マウスボタンの意味が入れ替えられていなかった場合、戻り値は 0 になります。

解説(Remarks)

ボタンの入れ替えは、左手でマウスを使用する人のための便宜として提供されています。SwapMouseButton 関数は通常、コントロールパネルからのみ呼び出されます。アプリケーションがこの関数を自由に呼び出すことはできますが、マウスは共有リソースであり、そのボタンの意味を入れ替えると、すべてのアプリケーションに影響します。

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

各言語での呼び出し定義

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

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

SwapMouseButton = ctypes.windll.user32.SwapMouseButton
SwapMouseButton.restype = wintypes.BOOL
SwapMouseButton.argtypes = [
    wintypes.BOOL,  # fSwap : BOOL
]
require 'fiddle'
require 'fiddle/import'

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

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procSwapMouseButton = user32.NewProc("SwapMouseButton")
)

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

extern "user32" fn SwapMouseButton(
    fSwap: i32 // BOOL
) callconv(std.os.windows.WINAPI) i32;
proc SwapMouseButton(
    fSwap: int32  # BOOL
): int32 {.importc: "SwapMouseButton", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
int SwapMouseButton(
    int fSwap   // BOOL
);
ccall((:SwapMouseButton, "USER32.dll"), stdcall, Int32,
      (Int32,),
      fSwap)
# fSwap : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SwapMouseButton(
    int32_t fSwap);
]]
local user32 = ffi.load("user32")
-- user32.SwapMouseButton(fSwap)
-- fSwap : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const SwapMouseButton = lib.func('__stdcall', 'SwapMouseButton', 'int32_t', ['int32_t']);
// SwapMouseButton(fSwap)
// fSwap : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  SwapMouseButton: { parameters: ["i32"], result: "i32" },
});
// lib.symbols.SwapMouseButton(fSwap)
// fSwap : BOOL -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SwapMouseButton(
    int32_t fSwap);
C, "USER32.dll");
// $ffi->SwapMouseButton(fSwap);
// fSwap : BOOL
// 構造体/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 User32 extends StdCallLibrary {
    User32 INSTANCE = Native.load("user32", User32.class);
    boolean SwapMouseButton(
        boolean fSwap   // BOOL
    );
}
@[Link("user32")]
lib LibUSER32
  fun SwapMouseButton = SwapMouseButton(
    fSwap : Int32   # BOOL
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SwapMouseButtonNative = Int32 Function(Int32);
typedef SwapMouseButtonDart = int Function(int);
final SwapMouseButton = DynamicLibrary.open('USER32.dll')
    .lookupFunction<SwapMouseButtonNative, SwapMouseButtonDart>('SwapMouseButton');
// fSwap : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SwapMouseButton(
  fSwap: BOOL   // BOOL
): BOOL; stdcall;
  external 'USER32.dll' name 'SwapMouseButton';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let swapmousebutton =
  foreign "SwapMouseButton"
    (int32_t @-> returning int32_t)
(* fSwap : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("SwapMouseButton" swap-mouse-button :convention :stdcall) :int32
  (f-swap :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SwapMouseButton = Win32::API::More->new('USER32',
    'BOOL SwapMouseButton(BOOL fSwap)');
# my $ret = $SwapMouseButton->Call($fSwap);
# fSwap : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目