Win32 API 日本語リファレンス
ホームUI.Shell › SHAppBarMessage

SHAppBarMessage

関数
アプリケーションバーにメッセージを送信して登録や設定を行う。
DLLSHELL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

UINT_PTR SHAppBarMessage(
    DWORD dwMessage,
    APPBARDATA* pData
);

パラメーター

名前方向説明
dwMessageDWORDin

送信するアプリバーメッセージの値です。このパラメーターには次のいずれかの値を指定できます。

ABM_NEW (0x00000000)

新しいアプリバーを登録し、システムがアプリバーへ通知メッセージを送信する際に使用するメッセージ識別子を指定します。

ABM_REMOVE (0x00000001)

アプリバーの登録を解除し、システム内部のリストからバーを削除します。

ABM_QUERYPOS (0x00000002)

アプリバーのサイズと画面上の位置を要求します。

ABM_SETPOS (0x00000003)

アプリバーのサイズと画面上の位置を設定します。

ABM_GETSTATE (0x00000004)

Windows タスクバーの自動的に隠す状態 (autohide) と常に手前に表示する状態 (always-on-top) を取得します。

ABM_GETTASKBARPOS (0x00000005)

Windows タスクバーの外接矩形を取得します。これはシステムタスクバーにのみ適用される点に注意してください。サードパーティ製ソフトウェアに付属するツールバーなど、ほかのオブジェクトが存在する場合もあります。その結果、Windows タスクバーで覆われていない画面領域の一部がユーザーから見えないことがあります。タスクバーとほかのアプリバーの両方で覆われていない画面領域、つまりアプリケーションが利用可能な作業領域を取得するには、GetMonitorInfo 関数を使用してください。

ABM_ACTIVATE (0x00000006)

アプリバーをアクティブ化または非アクティブ化するようシステムに通知します。pData が指す APPBARDATAlParam メンバーには、アクティブ化する場合は TRUE、非アクティブ化する場合は FALSE を設定します。

ABM_GETAUTOHIDEBAR (0x00000007)

画面の特定の端に関連付けられた自動的に隠すアプリバーのハンドルを取得します。

ABM_SETAUTOHIDEBAR (0x00000008)

画面の端に対する自動的に隠すアプリバーを登録または登録解除します。

ABM_WINDOWPOSCHANGED (0x00000009)

アプリバーの位置が変更されたことをシステムに通知します。

ABM_SETSTATE (0x0000000A)

Windows XP 以降: アプリバーの自動的に隠す属性と常に手前に表示する属性の状態を設定します。

ABM_GETAUTOHIDEBAREX (0x0000000B)

Windows XP 以降: 特定のモニターの特定の端に関連付けられた自動的に隠すアプリバーのハンドルを取得します。

ABM_SETAUTOHIDEBAREX (0x0000000C)

Windows XP 以降: 特定のモニターの端に対する自動的に隠すアプリバーを登録または登録解除します。

pDataAPPBARDATA*inoutAPPBARDATA 構造体へのポインターです。呼び出し時および戻り時の構造体の内容は、dwMessage パラメーターに設定した値によって異なります。詳細は各メッセージのページを参照してください。

戻り値の型: UINT_PTR

公式ドキュメント

アプリバー (appbar) メッセージをシステムに送信します。

戻り値

Type: UINT_PTR

この関数はメッセージに依存する値を返します。詳細については、送信した特定のアプリバーメッセージに関する Windows SDK ドキュメントを参照してください。それらのドキュメントへのリンクは「関連項目」セクションに記載されています。

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

各言語での呼び出し定義

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

UINT_PTR SHAppBarMessage(
    DWORD dwMessage,
    APPBARDATA* pData
);
[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern UIntPtr SHAppBarMessage(
    uint dwMessage,   // DWORD
    IntPtr pData   // APPBARDATA* in/out
);
<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHAppBarMessage(
    dwMessage As UInteger,   ' DWORD
    pData As IntPtr   ' APPBARDATA* in/out
) As UIntPtr
End Function
' dwMessage : DWORD
' pData : APPBARDATA* in/out
Declare PtrSafe Function SHAppBarMessage Lib "shell32" ( _
    ByVal dwMessage As Long, _
    ByVal pData As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHAppBarMessage = ctypes.windll.shell32.SHAppBarMessage
SHAppBarMessage.restype = ctypes.c_size_t
SHAppBarMessage.argtypes = [
    wintypes.DWORD,  # dwMessage : DWORD
    ctypes.c_void_p,  # pData : APPBARDATA* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHAppBarMessage = shell32.NewProc("SHAppBarMessage")
)

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

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

typedef SHAppBarMessageNative = UintPtr Function(Uint32, Pointer<Void>);
typedef SHAppBarMessageDart = int Function(int, Pointer<Void>);
final SHAppBarMessage = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHAppBarMessageNative, SHAppBarMessageDart>('SHAppBarMessage');
// dwMessage : DWORD -> Uint32
// pData : APPBARDATA* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHAppBarMessage(
  dwMessage: DWORD;   // DWORD
  pData: Pointer   // APPBARDATA* in/out
): NativeUInt; stdcall;
  external 'SHELL32.dll' name 'SHAppBarMessage';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHAppBarMessage"
  c_SHAppBarMessage :: Word32 -> Ptr () -> IO CUIntPtr
-- dwMessage : DWORD -> Word32
-- pData : APPBARDATA* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shappbarmessage =
  foreign "SHAppBarMessage"
    (uint32_t @-> (ptr void) @-> returning size_t)
(* dwMessage : DWORD -> uint32_t *)
(* pData : APPBARDATA* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)

(cffi:defcfun ("SHAppBarMessage" shapp-bar-message :convention :stdcall) :uint64
  (dw-message :uint32)   ; DWORD
  (p-data :pointer))   ; APPBARDATA* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHAppBarMessage = Win32::API::More->new('SHELL32',
    'WPARAM SHAppBarMessage(DWORD dwMessage, LPVOID pData)');
# my $ret = $SHAppBarMessage->Call($dwMessage, $pData);
# dwMessage : DWORD -> DWORD
# pData : APPBARDATA* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型