ホーム › UI.Accessibility › SOUNDSENTRYA

SOUNDSENTRYA

構造体

📘 Microsoft Learn (日本語) · English

サイズx64: 56 バイト / x86: 48 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

型

サイズ

x64

x86

説明

cbSize

DWORD

この構造体のサイズをバイト単位で指定します。

dwFlags

SOUNDSENTRY_FLAGS

SoundSentry 機能のプロパティを指定するビットフラグのセットです。次のビットフラグ値が定義されています。

値	意味
SSF_AVAILABLE 0x00000002	このフラグが設定されている場合、SoundSentry 機能が利用可能です。
SSF_INDICATOR 0x00000004	このフラグは実装されていません。
SSF_SOUNDSENTRYON 0x00000001	このフラグが設定されている場合、SoundSentry 機能がオンです。

iFSTextEffect

SOUNDSENTRY_TEXT_EFFECT

Windows 95/98: テキストモードのアプリケーションがフルスクリーンの仮想マシンで実行中にサウンドを生成したときに表示する視覚信号を指定します。このメンバーには次のいずれかの値を指定できます。

値	意味
SSTF_BORDER 2	画面の境界(すなわちオーバースキャン領域)を点滅させます。一部のディスプレイでは利用できません。
SSTF_CHARS 1	画面の隅の文字を点滅させます。
SSTF_DISPLAY 3	画面全体を点滅させます。
SSTF_NONE 0	視覚信号なし

Windows NT/2000: このメンバーは将来の使用のために予約済みです。0 に設定しなければなりません。

iFSTextEffectMSec

DWORD

+12

Windows 95/98: フルスクリーンのテキストモードのアプリケーションがサウンドを生成したときに表示される視覚信号の継続時間をミリ秒単位で指定します。

Windows NT/2000: このメンバーは将来の使用のために予約済みです。0 に設定しなければなりません。

iFSTextEffectColorBits

DWORD

+16

Windows 95/98: フルスクリーンのテキストモードのアプリケーションがサウンドを生成したときに表示される視覚信号に使用する色の RGB 値を指定します。

Windows NT/2000: このメンバーは将来の使用のために予約済みです。0 に設定しなければなりません。

iFSGrafEffect

SOUND_SENTRY_GRAPHICS_EFFECT

+20

Windows 95/98: グラフィックスモードのアプリケーションがフルスクリーンの仮想マシンで実行中にサウンドを生成したときに表示する視覚信号を指定します。このメンバーには次のいずれかの値を指定できます。

値	意味
SSGF_DISPLAY 3	画面全体を点滅させます。
SSGF_NONE 0	視覚信号なし。

Windows NT/2000: このメンバーは将来の使用のために予約済みです。0 に設定しなければなりません。

iFSGrafEffectMSec

DWORD

+24

Windows 95/98: フルスクリーンのグラフィックスモードのアプリケーションがサウンドを生成したときに表示される視覚信号の継続時間をミリ秒単位で指定します。

Windows NT/2000: このメンバーは将来の使用のために予約済みです。0 に設定しなければなりません。

iFSGrafEffectColor

DWORD

+28

Windows 95/98: フルスクリーンのグラフィックスモードのアプリケーションがサウンドを生成したときに表示される視覚信号に使用する色の RGB 値を指定します。

Windows NT/2000: このメンバーは将来の使用のために予約済みです。0 に設定しなければなりません。

iWindowsEffect

SOUNDSENTRY_WINDOWS_EFFECT

+32

Windows ベースのアプリケーション、またはウィンドウ内で実行されている MS-DOS アプリケーションがサウンドを生成したときに表示する視覚信号を指定します。このメンバーには次のいずれかの値を指定できます。

値	意味
SSWF_CUSTOM 4	カスタムの視覚信号を使用します。
SSWF_DISPLAY 3	画面全体を点滅させます。
SSWF_NONE 0	視覚信号なし。
SSWF_TITLE 1	アクティブウィンドウのタイトルバーを点滅させます。
SSWF_WINDOW 2	アクティブウィンドウを点滅させます。

iWindowsEffectMSec

DWORD

+36

Windows 95/98: Win32 ベースのアプリケーション(またはウィンドウ内で実行されているアプリケーション)がサウンドを生成したときに表示される視覚信号の継続時間をミリ秒単位で指定します。

Windows NT/2000: このメンバーは将来の使用のために予約済みです。0 に設定しなければなりません。

lpszWindowsEffectDLL

LPSTR

8/4

+40

このメンバーは将来の使用のために予約済みです。NULL に設定してください。

iWindowsEffectOrdinal

DWORD

+48

+44

このメンバーは将来の使用のために予約済みです。0 に設定しなければなりません。

公式ドキュメント

SoundSentry ユーザー補助機能に関する情報を格納します。SoundSentry 機能がオンの場合、コンピューターはサウンドが生成されたときにのみ視覚的な通知を表示します。

Windows 95/98: 視覚的な通知は、コンピューターの内蔵スピーカーを通じてサウンドが生成されたときに表示されます。

Windows NT/2000: 視覚的な通知は、マルチメディアサウンドサービスまたはコンピューターのスピーカーのいずれかを通じてサウンドが生成されたときに表示されます。

解説(Remarks)

アプリケーションは、uiAction パラメーターに SPI_GETSOUNDSENTRY または SPI_SETSOUNDSENTRY を設定して SystemParametersInfo 関数を呼び出すときに、SOUNDSENTRY 構造体を使用します。SPI_GETSOUNDSENTRY を使用する場合、アプリケーションは SOUNDSENTRY 構造体の cbSize メンバーを指定しなければなりません。残りのメンバーは SystemParametersInfo 関数が設定します。SPI_SETSOUNDSENTRY 値を使用する場合、アプリケーションは cbSize、dwFlags、iWindowsEffect の各メンバーを指定しなければなりません。

メモ

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

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

各言語での定義

#include <windows.h>

// SOUNDSENTRYA  (x64 56 / x86 48 バイト)
typedef struct SOUNDSENTRYA {
    DWORD cbSize;
    SOUNDSENTRY_FLAGS dwFlags;
    SOUNDSENTRY_TEXT_EFFECT iFSTextEffect;
    DWORD iFSTextEffectMSec;
    DWORD iFSTextEffectColorBits;
    SOUND_SENTRY_GRAPHICS_EFFECT iFSGrafEffect;
    DWORD iFSGrafEffectMSec;
    DWORD iFSGrafEffectColor;
    SOUNDSENTRY_WINDOWS_EFFECT iWindowsEffect;
    DWORD iWindowsEffectMSec;
    LPSTR lpszWindowsEffectDLL;
    DWORD iWindowsEffectOrdinal;
} SOUNDSENTRYA;

using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct SOUNDSENTRYA
{
    public uint cbSize;
    public uint dwFlags;
    public uint iFSTextEffect;
    public uint iFSTextEffectMSec;
    public uint iFSTextEffectColorBits;
    public uint iFSGrafEffect;
    public uint iFSGrafEffectMSec;
    public uint iFSGrafEffectColor;
    public uint iWindowsEffect;
    public uint iWindowsEffectMSec;
    public IntPtr lpszWindowsEffectDLL;
    public uint iWindowsEffectOrdinal;
}

Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure SOUNDSENTRYA
    Public cbSize As UInteger
    Public dwFlags As UInteger
    Public iFSTextEffect As UInteger
    Public iFSTextEffectMSec As UInteger
    Public iFSTextEffectColorBits As UInteger
    Public iFSGrafEffect As UInteger
    Public iFSGrafEffectMSec As UInteger
    Public iFSGrafEffectColor As UInteger
    Public iWindowsEffect As UInteger
    Public iWindowsEffectMSec As UInteger
    Public lpszWindowsEffectDLL As IntPtr
    Public iWindowsEffectOrdinal As UInteger
End Structure

import ctypes
from ctypes import wintypes

class SOUNDSENTRYA(ctypes.Structure):
    _fields_ = [
        ("cbSize", wintypes.DWORD),
        ("dwFlags", wintypes.DWORD),
        ("iFSTextEffect", wintypes.DWORD),
        ("iFSTextEffectMSec", wintypes.DWORD),
        ("iFSTextEffectColorBits", wintypes.DWORD),
        ("iFSGrafEffect", wintypes.DWORD),
        ("iFSGrafEffectMSec", wintypes.DWORD),
        ("iFSGrafEffectColor", wintypes.DWORD),
        ("iWindowsEffect", wintypes.DWORD),
        ("iWindowsEffectMSec", wintypes.DWORD),
        ("lpszWindowsEffectDLL", ctypes.c_void_p),
        ("iWindowsEffectOrdinal", wintypes.DWORD),
    ]

#[repr(C)]
pub struct SOUNDSENTRYA {
    pub cbSize: u32,
    pub dwFlags: u32,
    pub iFSTextEffect: u32,
    pub iFSTextEffectMSec: u32,
    pub iFSTextEffectColorBits: u32,
    pub iFSGrafEffect: u32,
    pub iFSGrafEffectMSec: u32,
    pub iFSGrafEffectColor: u32,
    pub iWindowsEffect: u32,
    pub iWindowsEffectMSec: u32,
    pub lpszWindowsEffectDLL: *mut core::ffi::c_void,
    pub iWindowsEffectOrdinal: u32,
}

import "golang.org/x/sys/windows"

type SOUNDSENTRYA struct {
	cbSize uint32
	dwFlags uint32
	iFSTextEffect uint32
	iFSTextEffectMSec uint32
	iFSTextEffectColorBits uint32
	iFSGrafEffect uint32
	iFSGrafEffectMSec uint32
	iFSGrafEffectColor uint32
	iWindowsEffect uint32
	iWindowsEffectMSec uint32
	lpszWindowsEffectDLL uintptr
	iWindowsEffectOrdinal uint32
}

type
  SOUNDSENTRYA = record
    cbSize: DWORD;
    dwFlags: DWORD;
    iFSTextEffect: DWORD;
    iFSTextEffectMSec: DWORD;
    iFSTextEffectColorBits: DWORD;
    iFSGrafEffect: DWORD;
    iFSGrafEffectMSec: DWORD;
    iFSGrafEffectColor: DWORD;
    iWindowsEffect: DWORD;
    iWindowsEffectMSec: DWORD;
    lpszWindowsEffectDLL: Pointer;
    iWindowsEffectOrdinal: DWORD;
  end;

const SOUNDSENTRYA = extern struct {
    cbSize: u32,
    dwFlags: u32,
    iFSTextEffect: u32,
    iFSTextEffectMSec: u32,
    iFSTextEffectColorBits: u32,
    iFSGrafEffect: u32,
    iFSGrafEffectMSec: u32,
    iFSGrafEffectColor: u32,
    iWindowsEffect: u32,
    iWindowsEffectMSec: u32,
    lpszWindowsEffectDLL: ?*anyopaque,
    iWindowsEffectOrdinal: u32,
};

type
  SOUNDSENTRYA {.bycopy.} = object
    cbSize: uint32
    dwFlags: uint32
    iFSTextEffect: uint32
    iFSTextEffectMSec: uint32
    iFSTextEffectColorBits: uint32
    iFSGrafEffect: uint32
    iFSGrafEffectMSec: uint32
    iFSGrafEffectColor: uint32
    iWindowsEffect: uint32
    iWindowsEffectMSec: uint32
    lpszWindowsEffectDLL: pointer
    iWindowsEffectOrdinal: uint32

struct SOUNDSENTRYA
{
    uint cbSize;
    uint dwFlags;
    uint iFSTextEffect;
    uint iFSTextEffectMSec;
    uint iFSTextEffectColorBits;
    uint iFSGrafEffect;
    uint iFSGrafEffectMSec;
    uint iFSGrafEffectColor;
    uint iWindowsEffect;
    uint iWindowsEffectMSec;
    void* lpszWindowsEffectDLL;
    uint iWindowsEffectOrdinal;
}

HSP用定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; SOUNDSENTRYA サイズ: 48 バイト(x86)
dim st, 12    ; 4byte整数×12(構造体サイズ 48 / 4 切り上げ)
; cbSize : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; dwFlags : SOUNDSENTRY_FLAGS (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; iFSTextEffect : SOUNDSENTRY_TEXT_EFFECT (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; iFSTextEffectMSec : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; iFSTextEffectColorBits : DWORD (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; iFSGrafEffect : SOUND_SENTRY_GRAPHICS_EFFECT (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; iFSGrafEffectMSec : DWORD (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; iFSGrafEffectColor : DWORD (+28, 4byte)  st.7 = 値  /  値 = st.7   (lpoke/lpeek も可)
; iWindowsEffect : SOUNDSENTRY_WINDOWS_EFFECT (+32, 4byte)  st.8 = 値  /  値 = st.8   (lpoke/lpeek も可)
; iWindowsEffectMSec : DWORD (+36, 4byte)  st.9 = 値  /  値 = st.9   (lpoke/lpeek も可)
; lpszWindowsEffectDLL : LPSTR (+40, 4byte)  st.10 = 値  /  値 = st.10   (lpoke/lpeek も可)
; iWindowsEffectOrdinal : DWORD (+44, 4byte)  st.11 = 値  /  値 = st.11   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; SOUNDSENTRYA サイズ: 56 バイト(x64)
dim st, 14    ; 4byte整数×14(構造体サイズ 56 / 4 切り上げ)
; cbSize : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; dwFlags : SOUNDSENTRY_FLAGS (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; iFSTextEffect : SOUNDSENTRY_TEXT_EFFECT (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; iFSTextEffectMSec : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; iFSTextEffectColorBits : DWORD (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; iFSGrafEffect : SOUND_SENTRY_GRAPHICS_EFFECT (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; iFSGrafEffectMSec : DWORD (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; iFSGrafEffectColor : DWORD (+28, 4byte)  st.7 = 値  /  値 = st.7   (lpoke/lpeek も可)
; iWindowsEffect : SOUNDSENTRY_WINDOWS_EFFECT (+32, 4byte)  st.8 = 値  /  値 = st.8   (lpoke/lpeek も可)
; iWindowsEffectMSec : DWORD (+36, 4byte)  st.9 = 値  /  値 = st.9   (lpoke/lpeek も可)
; lpszWindowsEffectDLL : LPSTR (+40, 8byte)  qpoke st,40,値 / qpeek(st,40)  ※IronHSPのみ。3.7/3.8は lpoke st,40,下位 : lpoke st,44,上位
; iWindowsEffectOrdinal : DWORD (+48, 4byte)  st.12 = 値  /  値 = st.12   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。

; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global SOUNDSENTRYA
    #field int cbSize
    #field int dwFlags
    #field int iFSTextEffect
    #field int iFSTextEffectMSec
    #field int iFSTextEffectColorBits
    #field int iFSGrafEffect
    #field int iFSGrafEffectMSec
    #field int iFSGrafEffectColor
    #field int iWindowsEffect
    #field int iWindowsEffectMSec
    #field intptr lpszWindowsEffectDLL
    #field int iWindowsEffectOrdinal
#endstruct

stdim st, SOUNDSENTRYA        ; NSTRUCT 変数を確保
st->cbSize = 100
mes "cbSize=" + st->cbSize

SOUNDSENTRYA

フィールド

公式ドキュメント

解説(Remarks)

各言語での定義

HSP用 定義

HSP用定義