Win32 API 日本語リファレンス
ホームDevices.Tapi › PHONESTATUS

PHONESTATUS

構造体
サイズx64: 104 バイト / x86: 104 バイトパッキング1

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

フィールド

フィールドサイズx64x86説明
dwTotalSizeDWORD4+0+0このデータ構造体に割り当てられた合計サイズ(バイト単位)。
dwNeededSizeDWORD4+4+4返されるすべての情報を保持するために必要な、このデータ構造体のサイズ(バイト単位)。
dwUsedSizeDWORD4+8+8このデータ構造体のうち、有用な情報が格納されている部分のサイズ(バイト単位)。
dwStatusFlagsDWORD4+12+12この電話デバイスの状態フラグ。このメンバーは、 PHONESTATUSFLAGS_ 定数のいずれか 1 つを使用します。
dwNumOwnersDWORD4+16+16この電話に対して所有者権限を持つアプリケーションモジュールの数。
dwNumMonitorsDWORD4+20+20この電話に対してモニター権限を持つアプリケーションモジュールの数。
dwRingModeDWORD4+24+24電話デバイスの現在の呼び出し音モード。
dwRingVolumeDWORD4+28+28電話デバイスの現在の呼び出し音の音量。0x00000000(無音)から 0x0000FFFF(最大音量)までの値です。
dwHandsetHookSwitchModeDWORD4+32+32電話のハンドセットの現在のフックスイッチモード。このメンバーは、 PHONEHOOKSWITCHMODE_ 定数のいずれか 1 つを使用します。
dwHandsetVolumeDWORD4+36+36電話のハンドセットデバイスの現在のスピーカー音量。0x00000000(無音)から 0x0000FFFF(最大音量)までの値です。
dwHandsetGainDWORD4+40+40電話のハンドセットデバイスの現在のマイク利得。0x00000000(無音)から 0x0000FFFF(最大利得)までの値です。
dwSpeakerHookSwitchModeDWORD4+44+44電話のスピーカーフォンの現在のフックスイッチモード。このメンバーは、 PHONEHOOKSWITCHMODE_ 定数のいずれか 1 つを使用します。
dwSpeakerVolumeDWORD4+48+48電話のスピーカーデバイスの現在のスピーカー音量。0x00000000(無音)から 0x0000FFFF(最大音量)までの値です。
dwSpeakerGainDWORD4+52+52電話のスピーカーデバイスの現在のマイク利得。0x00000000(無音)から 0x0000FFFF(最大利得)までの値です。
dwHeadsetHookSwitchModeDWORD4+56+56電話のヘッドセットの現在のフックスイッチモード。このメンバーは、 PHONEHOOKSWITCHMODE_ 定数のいずれか 1 つを使用します。
dwHeadsetVolumeDWORD4+60+60電話のヘッドセットデバイスの現在のスピーカー音量。0x00000000(無音)から 0x0000FFFF(最大音量)までの値です。
dwHeadsetGainDWORD4+64+64電話のヘッドセットデバイスの現在のマイク利得。0x00000000(無音)から 0x0000FFFF(最大利得)までの値です。
dwDisplaySizeDWORD4+68+68表示情報のサイズ(バイト単位)。
dwDisplayOffsetDWORD4+72+72この構造体の先頭から、電話の現在の表示情報を格納する可変長フィールドまでのオフセット。このフィールドのサイズは dwDisplaySize で指定されます。
dwLampModesSizeDWORD4+76+76現在のランプモード配列のサイズ(バイト単位)。
dwLampModesOffsetDWORD4+80+80この構造体の先頭から、電話の現在のランプモードを格納する可変長フィールドまでのオフセット。このフィールドのサイズは dwLampModesSize で指定されます。
dwOwnerNameSizeDWORD4+84+84現在の所有者の名前のサイズ(null 終端文字を含む、バイト単位)。
dwOwnerNameOffsetDWORD4+88+88この構造体の先頭から、電話デバイスの現在の所有者であるアプリケーションの名前を格納する可変長フィールドまでのオフセット。この名前は、アプリケーションが phoneInitialize または phoneInitializeEx を呼び出したときに指定したアプリケーション名です。アプリケーション名が指定されなかった場合は、代わりにアプリケーションのファイル名が使用されます。このフィールドのサイズは dwOwnerNameSize で指定されます。電話に現在所有者がいない場合、dwOwnerNameSize は 0 です。
dwDevSpecificSizeDWORD4+92+92デバイス固有フィールドのサイズ(バイト単位)。デバイス固有の情報が文字列へのポインターである場合、このサイズには null 終端文字を含めなければなりません。
dwDevSpecificOffsetDWORD4+96+96この構造体の先頭から、可変長のデバイス固有フィールドまでのオフセット。このフィールドのサイズは dwDevSpecificSize で指定されます。
dwPhoneFeaturesDWORD4+100+100デバイスの能力における機能の有無、現在のデバイスの状態、および呼び出し元アプリケーションのデバイス所有権を考慮して、この電話に対してどのテレフォニー API 関数を呼び出せるかを示すフラグ。0 は、現在の状態の電話に対して該当する機能をアプリケーションが呼び出せないことを示し、1 は呼び出せることを示します。このメンバーは、 PHONEFEATURE_ 定数の 1 つ以上を使用します。

公式ドキュメント

PHONESTATUS 構造体は、電話デバイスの現在の状態を記述します。 phoneGetStatus 関数および TSPI_phoneGetStatus 関数は、この構造体を返します。

解説(Remarks)

デバイス固有の拡張には、このデータ構造体の DevSpecific(dwDevSpecificSize および dwDevSpecificOffset)可変長領域を使用してください。

dwPhoneFeatures メンバーは、API バージョン 2.0 以降で電話デバイスを開いたアプリケーションでのみ使用できます。

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

各言語での定義

#include <windows.h>

// PHONESTATUS  (x64 104 / x86 104 バイト)
#pragma pack(push, 1)
typedef struct PHONESTATUS {
    DWORD dwTotalSize;
    DWORD dwNeededSize;
    DWORD dwUsedSize;
    DWORD dwStatusFlags;
    DWORD dwNumOwners;
    DWORD dwNumMonitors;
    DWORD dwRingMode;
    DWORD dwRingVolume;
    DWORD dwHandsetHookSwitchMode;
    DWORD dwHandsetVolume;
    DWORD dwHandsetGain;
    DWORD dwSpeakerHookSwitchMode;
    DWORD dwSpeakerVolume;
    DWORD dwSpeakerGain;
    DWORD dwHeadsetHookSwitchMode;
    DWORD dwHeadsetVolume;
    DWORD dwHeadsetGain;
    DWORD dwDisplaySize;
    DWORD dwDisplayOffset;
    DWORD dwLampModesSize;
    DWORD dwLampModesOffset;
    DWORD dwOwnerNameSize;
    DWORD dwOwnerNameOffset;
    DWORD dwDevSpecificSize;
    DWORD dwDevSpecificOffset;
    DWORD dwPhoneFeatures;
} PHONESTATUS;
#pragma pack(pop)
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, Pack = 1, CharSet = CharSet.Unicode)]
public struct PHONESTATUS
{
    public uint dwTotalSize;
    public uint dwNeededSize;
    public uint dwUsedSize;
    public uint dwStatusFlags;
    public uint dwNumOwners;
    public uint dwNumMonitors;
    public uint dwRingMode;
    public uint dwRingVolume;
    public uint dwHandsetHookSwitchMode;
    public uint dwHandsetVolume;
    public uint dwHandsetGain;
    public uint dwSpeakerHookSwitchMode;
    public uint dwSpeakerVolume;
    public uint dwSpeakerGain;
    public uint dwHeadsetHookSwitchMode;
    public uint dwHeadsetVolume;
    public uint dwHeadsetGain;
    public uint dwDisplaySize;
    public uint dwDisplayOffset;
    public uint dwLampModesSize;
    public uint dwLampModesOffset;
    public uint dwOwnerNameSize;
    public uint dwOwnerNameOffset;
    public uint dwDevSpecificSize;
    public uint dwDevSpecificOffset;
    public uint dwPhoneFeatures;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, Pack:=1, CharSet:=CharSet.Unicode)>
Public Structure PHONESTATUS
    Public dwTotalSize As UInteger
    Public dwNeededSize As UInteger
    Public dwUsedSize As UInteger
    Public dwStatusFlags As UInteger
    Public dwNumOwners As UInteger
    Public dwNumMonitors As UInteger
    Public dwRingMode As UInteger
    Public dwRingVolume As UInteger
    Public dwHandsetHookSwitchMode As UInteger
    Public dwHandsetVolume As UInteger
    Public dwHandsetGain As UInteger
    Public dwSpeakerHookSwitchMode As UInteger
    Public dwSpeakerVolume As UInteger
    Public dwSpeakerGain As UInteger
    Public dwHeadsetHookSwitchMode As UInteger
    Public dwHeadsetVolume As UInteger
    Public dwHeadsetGain As UInteger
    Public dwDisplaySize As UInteger
    Public dwDisplayOffset As UInteger
    Public dwLampModesSize As UInteger
    Public dwLampModesOffset As UInteger
    Public dwOwnerNameSize As UInteger
    Public dwOwnerNameOffset As UInteger
    Public dwDevSpecificSize As UInteger
    Public dwDevSpecificOffset As UInteger
    Public dwPhoneFeatures As UInteger
End Structure
import ctypes
from ctypes import wintypes

class PHONESTATUS(ctypes.Structure):
    _pack_ = 1
    _fields_ = [
        ("dwTotalSize", wintypes.DWORD),
        ("dwNeededSize", wintypes.DWORD),
        ("dwUsedSize", wintypes.DWORD),
        ("dwStatusFlags", wintypes.DWORD),
        ("dwNumOwners", wintypes.DWORD),
        ("dwNumMonitors", wintypes.DWORD),
        ("dwRingMode", wintypes.DWORD),
        ("dwRingVolume", wintypes.DWORD),
        ("dwHandsetHookSwitchMode", wintypes.DWORD),
        ("dwHandsetVolume", wintypes.DWORD),
        ("dwHandsetGain", wintypes.DWORD),
        ("dwSpeakerHookSwitchMode", wintypes.DWORD),
        ("dwSpeakerVolume", wintypes.DWORD),
        ("dwSpeakerGain", wintypes.DWORD),
        ("dwHeadsetHookSwitchMode", wintypes.DWORD),
        ("dwHeadsetVolume", wintypes.DWORD),
        ("dwHeadsetGain", wintypes.DWORD),
        ("dwDisplaySize", wintypes.DWORD),
        ("dwDisplayOffset", wintypes.DWORD),
        ("dwLampModesSize", wintypes.DWORD),
        ("dwLampModesOffset", wintypes.DWORD),
        ("dwOwnerNameSize", wintypes.DWORD),
        ("dwOwnerNameOffset", wintypes.DWORD),
        ("dwDevSpecificSize", wintypes.DWORD),
        ("dwDevSpecificOffset", wintypes.DWORD),
        ("dwPhoneFeatures", wintypes.DWORD),
    ]
#[repr(C, packed(1))]
pub struct PHONESTATUS {
    pub dwTotalSize: u32,
    pub dwNeededSize: u32,
    pub dwUsedSize: u32,
    pub dwStatusFlags: u32,
    pub dwNumOwners: u32,
    pub dwNumMonitors: u32,
    pub dwRingMode: u32,
    pub dwRingVolume: u32,
    pub dwHandsetHookSwitchMode: u32,
    pub dwHandsetVolume: u32,
    pub dwHandsetGain: u32,
    pub dwSpeakerHookSwitchMode: u32,
    pub dwSpeakerVolume: u32,
    pub dwSpeakerGain: u32,
    pub dwHeadsetHookSwitchMode: u32,
    pub dwHeadsetVolume: u32,
    pub dwHeadsetGain: u32,
    pub dwDisplaySize: u32,
    pub dwDisplayOffset: u32,
    pub dwLampModesSize: u32,
    pub dwLampModesOffset: u32,
    pub dwOwnerNameSize: u32,
    pub dwOwnerNameOffset: u32,
    pub dwDevSpecificSize: u32,
    pub dwDevSpecificOffset: u32,
    pub dwPhoneFeatures: u32,
}
import "golang.org/x/sys/windows"

type PHONESTATUS struct {
	dwTotalSize uint32
	dwNeededSize uint32
	dwUsedSize uint32
	dwStatusFlags uint32
	dwNumOwners uint32
	dwNumMonitors uint32
	dwRingMode uint32
	dwRingVolume uint32
	dwHandsetHookSwitchMode uint32
	dwHandsetVolume uint32
	dwHandsetGain uint32
	dwSpeakerHookSwitchMode uint32
	dwSpeakerVolume uint32
	dwSpeakerGain uint32
	dwHeadsetHookSwitchMode uint32
	dwHeadsetVolume uint32
	dwHeadsetGain uint32
	dwDisplaySize uint32
	dwDisplayOffset uint32
	dwLampModesSize uint32
	dwLampModesOffset uint32
	dwOwnerNameSize uint32
	dwOwnerNameOffset uint32
	dwDevSpecificSize uint32
	dwDevSpecificOffset uint32
	dwPhoneFeatures uint32
}
type
  PHONESTATUS = packed record
    dwTotalSize: DWORD;
    dwNeededSize: DWORD;
    dwUsedSize: DWORD;
    dwStatusFlags: DWORD;
    dwNumOwners: DWORD;
    dwNumMonitors: DWORD;
    dwRingMode: DWORD;
    dwRingVolume: DWORD;
    dwHandsetHookSwitchMode: DWORD;
    dwHandsetVolume: DWORD;
    dwHandsetGain: DWORD;
    dwSpeakerHookSwitchMode: DWORD;
    dwSpeakerVolume: DWORD;
    dwSpeakerGain: DWORD;
    dwHeadsetHookSwitchMode: DWORD;
    dwHeadsetVolume: DWORD;
    dwHeadsetGain: DWORD;
    dwDisplaySize: DWORD;
    dwDisplayOffset: DWORD;
    dwLampModesSize: DWORD;
    dwLampModesOffset: DWORD;
    dwOwnerNameSize: DWORD;
    dwOwnerNameOffset: DWORD;
    dwDevSpecificSize: DWORD;
    dwDevSpecificOffset: DWORD;
    dwPhoneFeatures: DWORD;
  end;
const PHONESTATUS = extern struct {
    dwTotalSize: u32,
    dwNeededSize: u32,
    dwUsedSize: u32,
    dwStatusFlags: u32,
    dwNumOwners: u32,
    dwNumMonitors: u32,
    dwRingMode: u32,
    dwRingVolume: u32,
    dwHandsetHookSwitchMode: u32,
    dwHandsetVolume: u32,
    dwHandsetGain: u32,
    dwSpeakerHookSwitchMode: u32,
    dwSpeakerVolume: u32,
    dwSpeakerGain: u32,
    dwHeadsetHookSwitchMode: u32,
    dwHeadsetVolume: u32,
    dwHeadsetGain: u32,
    dwDisplaySize: u32,
    dwDisplayOffset: u32,
    dwLampModesSize: u32,
    dwLampModesOffset: u32,
    dwOwnerNameSize: u32,
    dwOwnerNameOffset: u32,
    dwDevSpecificSize: u32,
    dwDevSpecificOffset: u32,
    dwPhoneFeatures: u32,
};
type
  PHONESTATUS {.packed.} = object
    dwTotalSize: uint32
    dwNeededSize: uint32
    dwUsedSize: uint32
    dwStatusFlags: uint32
    dwNumOwners: uint32
    dwNumMonitors: uint32
    dwRingMode: uint32
    dwRingVolume: uint32
    dwHandsetHookSwitchMode: uint32
    dwHandsetVolume: uint32
    dwHandsetGain: uint32
    dwSpeakerHookSwitchMode: uint32
    dwSpeakerVolume: uint32
    dwSpeakerGain: uint32
    dwHeadsetHookSwitchMode: uint32
    dwHeadsetVolume: uint32
    dwHeadsetGain: uint32
    dwDisplaySize: uint32
    dwDisplayOffset: uint32
    dwLampModesSize: uint32
    dwLampModesOffset: uint32
    dwOwnerNameSize: uint32
    dwOwnerNameOffset: uint32
    dwDevSpecificSize: uint32
    dwDevSpecificOffset: uint32
    dwPhoneFeatures: uint32
align(1)
struct PHONESTATUS
{
    uint dwTotalSize;
    uint dwNeededSize;
    uint dwUsedSize;
    uint dwStatusFlags;
    uint dwNumOwners;
    uint dwNumMonitors;
    uint dwRingMode;
    uint dwRingVolume;
    uint dwHandsetHookSwitchMode;
    uint dwHandsetVolume;
    uint dwHandsetGain;
    uint dwSpeakerHookSwitchMode;
    uint dwSpeakerVolume;
    uint dwSpeakerGain;
    uint dwHeadsetHookSwitchMode;
    uint dwHeadsetVolume;
    uint dwHeadsetGain;
    uint dwDisplaySize;
    uint dwDisplayOffset;
    uint dwLampModesSize;
    uint dwLampModesOffset;
    uint dwOwnerNameSize;
    uint dwOwnerNameOffset;
    uint dwDevSpecificSize;
    uint dwDevSpecificOffset;
    uint dwPhoneFeatures;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; PHONESTATUS サイズ: 104 バイト(x64)
dim st, 26    ; 4byte整数×26(構造体サイズ 104 / 4 切り上げ)
; dwTotalSize : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; dwNeededSize : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; dwUsedSize : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; dwStatusFlags : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; dwNumOwners : DWORD (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; dwNumMonitors : DWORD (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; dwRingMode : DWORD (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; dwRingVolume : DWORD (+28, 4byte)  st.7 = 値  /  値 = st.7   (lpoke/lpeek も可)
; dwHandsetHookSwitchMode : DWORD (+32, 4byte)  st.8 = 値  /  値 = st.8   (lpoke/lpeek も可)
; dwHandsetVolume : DWORD (+36, 4byte)  st.9 = 値  /  値 = st.9   (lpoke/lpeek も可)
; dwHandsetGain : DWORD (+40, 4byte)  st.10 = 値  /  値 = st.10   (lpoke/lpeek も可)
; dwSpeakerHookSwitchMode : DWORD (+44, 4byte)  st.11 = 値  /  値 = st.11   (lpoke/lpeek も可)
; dwSpeakerVolume : DWORD (+48, 4byte)  st.12 = 値  /  値 = st.12   (lpoke/lpeek も可)
; dwSpeakerGain : DWORD (+52, 4byte)  st.13 = 値  /  値 = st.13   (lpoke/lpeek も可)
; dwHeadsetHookSwitchMode : DWORD (+56, 4byte)  st.14 = 値  /  値 = st.14   (lpoke/lpeek も可)
; dwHeadsetVolume : DWORD (+60, 4byte)  st.15 = 値  /  値 = st.15   (lpoke/lpeek も可)
; dwHeadsetGain : DWORD (+64, 4byte)  st.16 = 値  /  値 = st.16   (lpoke/lpeek も可)
; dwDisplaySize : DWORD (+68, 4byte)  st.17 = 値  /  値 = st.17   (lpoke/lpeek も可)
; dwDisplayOffset : DWORD (+72, 4byte)  st.18 = 値  /  値 = st.18   (lpoke/lpeek も可)
; dwLampModesSize : DWORD (+76, 4byte)  st.19 = 値  /  値 = st.19   (lpoke/lpeek も可)
; dwLampModesOffset : DWORD (+80, 4byte)  st.20 = 値  /  値 = st.20   (lpoke/lpeek も可)
; dwOwnerNameSize : DWORD (+84, 4byte)  st.21 = 値  /  値 = st.21   (lpoke/lpeek も可)
; dwOwnerNameOffset : DWORD (+88, 4byte)  st.22 = 値  /  値 = st.22   (lpoke/lpeek も可)
; dwDevSpecificSize : DWORD (+92, 4byte)  st.23 = 値  /  値 = st.23   (lpoke/lpeek も可)
; dwDevSpecificOffset : DWORD (+96, 4byte)  st.24 = 値  /  値 = st.24   (lpoke/lpeek も可)
; dwPhoneFeatures : DWORD (+100, 4byte)  st.25 = 値  /  値 = st.25   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global PHONESTATUS, pack=1
    #field int dwTotalSize
    #field int dwNeededSize
    #field int dwUsedSize
    #field int dwStatusFlags
    #field int dwNumOwners
    #field int dwNumMonitors
    #field int dwRingMode
    #field int dwRingVolume
    #field int dwHandsetHookSwitchMode
    #field int dwHandsetVolume
    #field int dwHandsetGain
    #field int dwSpeakerHookSwitchMode
    #field int dwSpeakerVolume
    #field int dwSpeakerGain
    #field int dwHeadsetHookSwitchMode
    #field int dwHeadsetVolume
    #field int dwHeadsetGain
    #field int dwDisplaySize
    #field int dwDisplayOffset
    #field int dwLampModesSize
    #field int dwLampModesOffset
    #field int dwOwnerNameSize
    #field int dwOwnerNameOffset
    #field int dwDevSpecificSize
    #field int dwDevSpecificOffset
    #field int dwPhoneFeatures
#endstruct

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