ホーム › Devices.Tapi › lineGetStatusMessages

lineGetStatusMessages

関数

回線やアドレス状態変化の通知対象を取得する。

DLLTAPI32.dll呼出規約winapi

シグネチャ

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

INT lineGetStatusMessages(
    DWORD hLine,
    DWORD* lpdwLineStates,
    DWORD* lpdwAddressStates
);

パラメーター

名前	型	方向	説明
hLine	DWORD	in	回線デバイスのハンドル。
lpdwLineStates	DWORD*	inout	どの回線デバイスの状態変化に対してアプリケーションへメッセージを送信するかを識別するビット配列。フラグが TRUE の場合、そのメッセージは有効になります。FALSE の場合は無効になります。このパラメーターには、 LINEDEVSTATE_ 定数のうち 1 つ以上を使用します。
lpdwAddressStates	DWORD*	inout	どのアドレスの状態変化に対してアプリケーションへメッセージを送信するかを識別するビット配列。フラグが TRUE の場合、そのメッセージは有効になります。FALSE の場合は無効になります。このパラメーターには、 LINEADDRESSSTATE_ 定数のうち 1 つ以上を使用します。

戻り値の型: INT

公式ドキュメント

lineGetStatusMessages 関数を使用すると、アプリケーションは、指定した回線またはそのいずれかのアドレスに関する状態変化イベントについて、どの通知メッセージを受信するように設定されているかを照会できます。

戻り値

要求が成功した場合は 0 を返し、エラーが発生した場合は負のエラー番号を返します。返される可能性のある値は次のとおりです。

LINEERR_INVALLINEHANDLE、LINEERR_OPERATIONFAILED、LINEERR_INVALPOINTER、LINEERR_RESOURCEUNAVAIL、LINEERR_NOMEM、LINEERR_UNINITIALIZED。

解説(Remarks)

TAPI は、回線およびアドレスで発生するイベントをアプリケーションに通知するためのメッセージをいくつか定義しています。アプリケーションによっては、アドレスと回線のすべての状態変化メッセージを受信する必要がない場合もあります。 lineSetStatusMessages 関数を使用すると、アプリケーションが受信するメッセージを選択できます。既定では、アドレス状態および回線状態の報告は無効になっています。

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

各言語での呼び出し定義

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

INT lineGetStatusMessages(
    DWORD hLine,
    DWORD* lpdwLineStates,
    DWORD* lpdwAddressStates
);

[DllImport("TAPI32.dll", ExactSpelling = true)]
static extern int lineGetStatusMessages(
    uint hLine,   // DWORD
    ref uint lpdwLineStates,   // DWORD* in/out
    ref uint lpdwAddressStates   // DWORD* in/out
);

<DllImport("TAPI32.dll", ExactSpelling:=True)>
Public Shared Function lineGetStatusMessages(
    hLine As UInteger,   ' DWORD
    ByRef lpdwLineStates As UInteger,   ' DWORD* in/out
    ByRef lpdwAddressStates As UInteger   ' DWORD* in/out
) As Integer
End Function

' hLine : DWORD
' lpdwLineStates : DWORD* in/out
' lpdwAddressStates : DWORD* in/out
Declare PtrSafe Function lineGetStatusMessages Lib "tapi32" ( _
    ByVal hLine As Long, _
    ByRef lpdwLineStates As Long, _
    ByRef lpdwAddressStates As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

lineGetStatusMessages = ctypes.windll.tapi32.lineGetStatusMessages
lineGetStatusMessages.restype = ctypes.c_int
lineGetStatusMessages.argtypes = [
    wintypes.DWORD,  # hLine : DWORD
    ctypes.POINTER(wintypes.DWORD),  # lpdwLineStates : DWORD* in/out
    ctypes.POINTER(wintypes.DWORD),  # lpdwAddressStates : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('TAPI32.dll')
lineGetStatusMessages = Fiddle::Function.new(
  lib['lineGetStatusMessages'],
  [
    -Fiddle::TYPE_INT,  # hLine : DWORD
    Fiddle::TYPE_VOIDP,  # lpdwLineStates : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # lpdwAddressStates : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "tapi32")]
extern "system" {
    fn lineGetStatusMessages(
        hLine: u32,  // DWORD
        lpdwLineStates: *mut u32,  // DWORD* in/out
        lpdwAddressStates: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("TAPI32.dll")]
public static extern int lineGetStatusMessages(uint hLine, ref uint lpdwLineStates, ref uint lpdwAddressStates);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TAPI32_lineGetStatusMessages' -Namespace Win32 -PassThru
# $api::lineGetStatusMessages(hLine, lpdwLineStates, lpdwAddressStates)

#uselib "TAPI32.dll"
#func global lineGetStatusMessages "lineGetStatusMessages" sptr, sptr, sptr
; lineGetStatusMessages hLine, varptr(lpdwLineStates), varptr(lpdwAddressStates)   ; 戻り値は stat
; hLine : DWORD -> "sptr"
; lpdwLineStates : DWORD* in/out -> "sptr"
; lpdwAddressStates : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "TAPI32.dll"
#cfunc global lineGetStatusMessages "lineGetStatusMessages" int, var, var
; res = lineGetStatusMessages(hLine, lpdwLineStates, lpdwAddressStates)
; hLine : DWORD -> "int"
; lpdwLineStates : DWORD* in/out -> "var"
; lpdwAddressStates : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "TAPI32.dll"
#cfunc global lineGetStatusMessages "lineGetStatusMessages" int, sptr, sptr
; res = lineGetStatusMessages(hLine, varptr(lpdwLineStates), varptr(lpdwAddressStates))
; hLine : DWORD -> "int"
; lpdwLineStates : DWORD* in/out -> "sptr"
; lpdwAddressStates : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。