ホーム › Devices.Tapi › lineSetStatusMessages
lineSetStatusMessages
関数回線やアドレスの状態変化通知を受け取る対象を設定する。
シグネチャ
// TAPI32.dll
#include <windows.h>
INT lineSetStatusMessages(
DWORD hLine,
DWORD dwLineStates,
DWORD dwAddressStates
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hLine | DWORD | in | 回線デバイスのハンドル。 |
| dwLineStates | DWORD | in | どの回線デバイスの状態変化についてアプリケーションにメッセージを送信するかを指定するビット配列。このパラメーターには、 LINEDEVSTATE_ Constants の 1 つ以上を使用します。 |
| dwAddressStates | DWORD | in | どのアドレスの状態変化についてアプリケーションにメッセージを送信するかを指定するビット配列。このパラメーターには、 LINEADDRESSSTATE_ Constants の 1 つ以上を使用します。 |
戻り値の型: INT
公式ドキュメント
lineSetStatusMessages 関数を使用すると、指定した回線またはそのいずれかのアドレスの状態変化に関連するイベントについて、どの通知メッセージを受け取るかをアプリケーションが指定できます。
戻り値
要求が成功した場合は 0 を返し、エラーが発生した場合は負のエラー番号を返します。返される可能性のある値は次のとおりです。
LINEERR_INVALADDRESSSTATE、LINEERR_OPERATIONFAILED、LINEERR_INVALLINEHANDLE、LINEERR_RESOURCEUNAVAIL、LINEERR_INVALLINESTATE、LINEERR_UNINITIALIZED、LINEERR_NOMEM、LINEERR_OPERATIONUNAVAIL。
解説(Remarks)
TAPI では、回線やアドレスで発生するイベントをアプリケーションに通知するためのメッセージが多数定義されています。アプリケーションによっては、すべてのアドレスおよび回線の状態変化メッセージを受け取る必要がない場合があります。 lineSetStatusMessages 関数を使用すると、アプリケーションが受け取るメッセージを選択できます。既定では、アドレスおよび回線の状態の報告は無効になっています。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// TAPI32.dll
#include <windows.h>
INT lineSetStatusMessages(
DWORD hLine,
DWORD dwLineStates,
DWORD dwAddressStates
);[DllImport("TAPI32.dll", ExactSpelling = true)]
static extern int lineSetStatusMessages(
uint hLine, // DWORD
uint dwLineStates, // DWORD
uint dwAddressStates // DWORD
);<DllImport("TAPI32.dll", ExactSpelling:=True)>
Public Shared Function lineSetStatusMessages(
hLine As UInteger, ' DWORD
dwLineStates As UInteger, ' DWORD
dwAddressStates As UInteger ' DWORD
) As Integer
End Function' hLine : DWORD
' dwLineStates : DWORD
' dwAddressStates : DWORD
Declare PtrSafe Function lineSetStatusMessages Lib "tapi32" ( _
ByVal hLine As Long, _
ByVal dwLineStates As Long, _
ByVal dwAddressStates As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
lineSetStatusMessages = ctypes.windll.tapi32.lineSetStatusMessages
lineSetStatusMessages.restype = ctypes.c_int
lineSetStatusMessages.argtypes = [
wintypes.DWORD, # hLine : DWORD
wintypes.DWORD, # dwLineStates : DWORD
wintypes.DWORD, # dwAddressStates : DWORD
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('TAPI32.dll')
lineSetStatusMessages = Fiddle::Function.new(
lib['lineSetStatusMessages'],
[
-Fiddle::TYPE_INT, # hLine : DWORD
-Fiddle::TYPE_INT, # dwLineStates : DWORD
-Fiddle::TYPE_INT, # dwAddressStates : DWORD
],
Fiddle::TYPE_INT)#[link(name = "tapi32")]
extern "system" {
fn lineSetStatusMessages(
hLine: u32, // DWORD
dwLineStates: u32, // DWORD
dwAddressStates: u32 // DWORD
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("TAPI32.dll")]
public static extern int lineSetStatusMessages(uint hLine, uint dwLineStates, uint dwAddressStates);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TAPI32_lineSetStatusMessages' -Namespace Win32 -PassThru
# $api::lineSetStatusMessages(hLine, dwLineStates, dwAddressStates)#uselib "TAPI32.dll"
#func global lineSetStatusMessages "lineSetStatusMessages" sptr, sptr, sptr
; lineSetStatusMessages hLine, dwLineStates, dwAddressStates ; 戻り値は stat
; hLine : DWORD -> "sptr"
; dwLineStates : DWORD -> "sptr"
; dwAddressStates : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "TAPI32.dll"
#cfunc global lineSetStatusMessages "lineSetStatusMessages" int, int, int
; res = lineSetStatusMessages(hLine, dwLineStates, dwAddressStates)
; hLine : DWORD -> "int"
; dwLineStates : DWORD -> "int"
; dwAddressStates : DWORD -> "int"; INT lineSetStatusMessages(DWORD hLine, DWORD dwLineStates, DWORD dwAddressStates)
#uselib "TAPI32.dll"
#cfunc global lineSetStatusMessages "lineSetStatusMessages" int, int, int
; res = lineSetStatusMessages(hLine, dwLineStates, dwAddressStates)
; hLine : DWORD -> "int"
; dwLineStates : DWORD -> "int"
; dwAddressStates : DWORD -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
tapi32 = windows.NewLazySystemDLL("TAPI32.dll")
proclineSetStatusMessages = tapi32.NewProc("lineSetStatusMessages")
)
// hLine (DWORD), dwLineStates (DWORD), dwAddressStates (DWORD)
r1, _, err := proclineSetStatusMessages.Call(
uintptr(hLine),
uintptr(dwLineStates),
uintptr(dwAddressStates),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction lineSetStatusMessages(
hLine: DWORD; // DWORD
dwLineStates: DWORD; // DWORD
dwAddressStates: DWORD // DWORD
): Integer; stdcall;
external 'TAPI32.dll' name 'lineSetStatusMessages';result := DllCall("TAPI32\lineSetStatusMessages"
, "UInt", hLine ; DWORD
, "UInt", dwLineStates ; DWORD
, "UInt", dwAddressStates ; DWORD
, "Int") ; return: INT●lineSetStatusMessages(hLine, dwLineStates, dwAddressStates) = DLL("TAPI32.dll", "int lineSetStatusMessages(dword, dword, dword)")
# 呼び出し: lineSetStatusMessages(hLine, dwLineStates, dwAddressStates)
# hLine : DWORD -> "dword"
# dwLineStates : DWORD -> "dword"
# dwAddressStates : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "tapi32" fn lineSetStatusMessages(
hLine: u32, // DWORD
dwLineStates: u32, // DWORD
dwAddressStates: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;proc lineSetStatusMessages(
hLine: uint32, # DWORD
dwLineStates: uint32, # DWORD
dwAddressStates: uint32 # DWORD
): int32 {.importc: "lineSetStatusMessages", stdcall, dynlib: "TAPI32.dll".}pragma(lib, "tapi32");
extern(Windows)
int lineSetStatusMessages(
uint hLine, // DWORD
uint dwLineStates, // DWORD
uint dwAddressStates // DWORD
);ccall((:lineSetStatusMessages, "TAPI32.dll"), stdcall, Int32,
(UInt32, UInt32, UInt32),
hLine, dwLineStates, dwAddressStates)
# hLine : DWORD -> UInt32
# dwLineStates : DWORD -> UInt32
# dwAddressStates : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t lineSetStatusMessages(
uint32_t hLine,
uint32_t dwLineStates,
uint32_t dwAddressStates);
]]
local tapi32 = ffi.load("tapi32")
-- tapi32.lineSetStatusMessages(hLine, dwLineStates, dwAddressStates)
-- hLine : DWORD
-- dwLineStates : DWORD
-- dwAddressStates : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('TAPI32.dll');
const lineSetStatusMessages = lib.func('__stdcall', 'lineSetStatusMessages', 'int32_t', ['uint32_t', 'uint32_t', 'uint32_t']);
// lineSetStatusMessages(hLine, dwLineStates, dwAddressStates)
// hLine : DWORD -> 'uint32_t'
// dwLineStates : DWORD -> 'uint32_t'
// dwAddressStates : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("TAPI32.dll", {
lineSetStatusMessages: { parameters: ["u32", "u32", "u32"], result: "i32" },
});
// lib.symbols.lineSetStatusMessages(hLine, dwLineStates, dwAddressStates)
// hLine : DWORD -> "u32"
// dwLineStates : DWORD -> "u32"
// dwAddressStates : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t lineSetStatusMessages(
uint32_t hLine,
uint32_t dwLineStates,
uint32_t dwAddressStates);
C, "TAPI32.dll");
// $ffi->lineSetStatusMessages(hLine, dwLineStates, dwAddressStates);
// hLine : DWORD
// dwLineStates : DWORD
// dwAddressStates : DWORD
// 構造体/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 Tapi32 extends StdCallLibrary {
Tapi32 INSTANCE = Native.load("tapi32", Tapi32.class);
int lineSetStatusMessages(
int hLine, // DWORD
int dwLineStates, // DWORD
int dwAddressStates // DWORD
);
}@[Link("tapi32")]
lib LibTAPI32
fun lineSetStatusMessages = lineSetStatusMessages(
hLine : UInt32, # DWORD
dwLineStates : UInt32, # DWORD
dwAddressStates : UInt32 # DWORD
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef lineSetStatusMessagesNative = Int32 Function(Uint32, Uint32, Uint32);
typedef lineSetStatusMessagesDart = int Function(int, int, int);
final lineSetStatusMessages = DynamicLibrary.open('TAPI32.dll')
.lookupFunction<lineSetStatusMessagesNative, lineSetStatusMessagesDart>('lineSetStatusMessages');
// hLine : DWORD -> Uint32
// dwLineStates : DWORD -> Uint32
// dwAddressStates : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function lineSetStatusMessages(
hLine: DWORD; // DWORD
dwLineStates: DWORD; // DWORD
dwAddressStates: DWORD // DWORD
): Integer; stdcall;
external 'TAPI32.dll' name 'lineSetStatusMessages';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "lineSetStatusMessages"
c_lineSetStatusMessages :: Word32 -> Word32 -> Word32 -> IO Int32
-- hLine : DWORD -> Word32
-- dwLineStates : DWORD -> Word32
-- dwAddressStates : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let linesetstatusmessages =
foreign "lineSetStatusMessages"
(uint32_t @-> uint32_t @-> uint32_t @-> returning int32_t)
(* hLine : DWORD -> uint32_t *)
(* dwLineStates : DWORD -> uint32_t *)
(* dwAddressStates : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library tapi32 (t "TAPI32.dll"))
(cffi:use-foreign-library tapi32)
(cffi:defcfun ("lineSetStatusMessages" line-set-status-messages :convention :stdcall) :int32
(h-line :uint32) ; DWORD
(dw-line-states :uint32) ; DWORD
(dw-address-states :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $lineSetStatusMessages = Win32::API::More->new('TAPI32',
'int lineSetStatusMessages(DWORD hLine, DWORD dwLineStates, DWORD dwAddressStates)');
# my $ret = $lineSetStatusMessages->Call($hLine, $dwLineStates, $dwAddressStates);
# hLine : DWORD -> DWORD
# dwLineStates : DWORD -> DWORD
# dwAddressStates : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- f lineInitialize — アプリ用にTAPIを初期化し回線デバイス数を取得する。
- f lineInitializeExW — 拡張パラメータ付きでTAPIを初期化する(Unicode版)。
- f lineOpenW — 回線デバイスを開いてハンドルを取得する(Unicode版)。