lineSetTerminal
関数シグネチャ
// TAPI32.dll
#include <windows.h>
INT lineSetTerminal(
DWORD hLine,
DWORD dwAddressID,
DWORD hCall,
DWORD dwSelect,
DWORD dwTerminalModes,
DWORD dwTerminalID,
DWORD bEnable
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hLine | DWORD | in | オープンされている回線デバイスのハンドル。 |
| dwAddressID | DWORD | in | 指定されたオープン済み回線デバイス上のアドレス。アドレス識別子はアドレスに永続的に関連付けられ、オペレーティングシステムのアップグレード後も変化しません。 |
| hCall | DWORD | in | 通話のハンドル。dwSelect が CALL の場合、hCall の通話状態は任意の状態で構いません。 |
| dwSelect | DWORD | in | 端末設定を回線、アドレス、または指定された通話のみのいずれに対して要求するか。回線またはアドレスを指定した場合、イベントは回線またはアドレス自体に適用されるか、その回線またはアドレス上のすべての新しい通話に対する既定の初期設定として機能します。このパラメーターには、 LINECALLSELECT_ 定数のいずれか 1 つを使用します。 |
| dwTerminalModes | DWORD | in | 指定された端末にルーティングされる低レベルイベントのクラス。このパラメーターには、 LINETERMMODE_ 定数の 1 つ以上を使用します。 |
| dwTerminalID | DWORD | in | 指定されたイベントのルーティング先となる端末デバイスのデバイス識別子。端末識別子は、0 から dwNumTerminals から 1 を引いた値までの範囲の小さい整数です。dwNumTerminals と、各端末が処理できる端末モードは、 lineGetDevCaps によって返されます。 これらの端末識別子は他のデバイス識別子とは関係がなく、サービスプロバイダーがデバイス機能を使用して定義します。 |
| bEnable | DWORD | in | TRUE の場合、dwTerminalID は有効であり、指定されたイベントクラスはその端末との間でルーティングされます。FALSE の場合、これらのイベントは、dwTerminalID と等しい識別子を持つ端末デバイスとの間でルーティングされません。 |
戻り値の型: INT
公式ドキュメント
lineSetTerminal 関数は、指定された回線、アドレス、または通話に関連する端末情報のうち、どの情報をルーティングするかをアプリケーションが指定できるようにします。
戻り値
関数が非同期に完了した場合は正の要求識別子を返し、エラーが発生した場合は負のエラー番号を返します。対応する LINE_REPLY メッセージの dwParam2 パラメーターは、関数が成功した場合は 0 となり、エラーが発生した場合は負のエラー番号となります。返される可能性のある値は次のとおりです。
LINEERR_INVALADDRESSID、LINEERR_NOMEM、LINEERR_INVALCALLHANDLE、LINEERR_OPERATIONUNAVAIL、LINEERR_INVALCALLSELECT、LINEERR_OPERATIONFAILED、LINEERR_INVALLINEHANDLE、LINEERR_RESOURCEUNAVAIL、LINEERR_INVALTERMINALID、LINEERR_UNINITIALIZED、LINEERR_INVALTERMINALMODE。
解説(Remarks)
アプリケーションはこの関数を使用して、特定のクラスの低レベル回線イベントを指定した端末デバイスにルーティングしたり、これらのイベントのルーティングを抑止したりできます。たとえば、音声をオーディオ I/O デバイス (ヘッドセット) にルーティングし、ランプと表示のイベントをローカルの電話デバイスにルーティングし、ボタンイベントと呼び出し音イベントを完全に抑止するといったことが可能です。
この関数は、指定された回線デバイス上で通話がアクティブな場合であっても、任意のタイミングで呼び出すことができます。これにより、ユーザーはローカルの電話機から別のオーディオ I/O デバイスに切り替えることができます。この関数を複数回呼び出して、同じイベントを複数の端末に同時にルーティングすることもできます。イベントのルーティング先を別の端末に変更するには、アプリケーションはまず既存の端末へのルーティングを無効にしてから、新しい端末にイベントをルーティングする必要があります。
端末識別子の割り当ては、その回線のサービスプロバイダーが行います。デバイス機能は、サービスプロバイダーが利用可能な端末識別子のみを示します。この種のイベントルーティングをサポートしないサービスプロバイダーは、端末デバイスを持たないことを示します ( LINEDEVCAPS の dwNumTerminals が 0 になります)。
回線またはアドレスに対して lineSetTerminal を呼び出すと、その回線またはアドレス上の既存のすべての通話に影響しますが、他のアドレス上の通話には影響しません。また、その回線またはアドレス上の今後の通話に対する既定値も設定されます。複数の接続済み通話を同時にアクティブにできる回線またはアドレスでは、通話ごとに異なるルーティングを有効にできます。
低レベルイベントが現在その端末との間でルーティングされていない状態で、その端末へのイベントのルーティングを無効にしても、関数が成功する限り (指定されたイベントがその端末との間でルーティングされない限り)、必ずしもエラーが発生するわけではありません。
TAPI は、呼び出しの進行状況を示すトーンとメッセージを、"メディア" に対して lineSetTerminal 関数で設定された場所と同じ場所にルーティングします。たとえば、音声信号が電話に送られる場合、話し中の信号 (アナログ) や話し中を示す Q.931 メッセージ (デジタル) も同じ場所に送られます。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// TAPI32.dll
#include <windows.h>
INT lineSetTerminal(
DWORD hLine,
DWORD dwAddressID,
DWORD hCall,
DWORD dwSelect,
DWORD dwTerminalModes,
DWORD dwTerminalID,
DWORD bEnable
);[DllImport("TAPI32.dll", ExactSpelling = true)]
static extern int lineSetTerminal(
uint hLine, // DWORD
uint dwAddressID, // DWORD
uint hCall, // DWORD
uint dwSelect, // DWORD
uint dwTerminalModes, // DWORD
uint dwTerminalID, // DWORD
uint bEnable // DWORD
);<DllImport("TAPI32.dll", ExactSpelling:=True)>
Public Shared Function lineSetTerminal(
hLine As UInteger, ' DWORD
dwAddressID As UInteger, ' DWORD
hCall As UInteger, ' DWORD
dwSelect As UInteger, ' DWORD
dwTerminalModes As UInteger, ' DWORD
dwTerminalID As UInteger, ' DWORD
bEnable As UInteger ' DWORD
) As Integer
End Function' hLine : DWORD
' dwAddressID : DWORD
' hCall : DWORD
' dwSelect : DWORD
' dwTerminalModes : DWORD
' dwTerminalID : DWORD
' bEnable : DWORD
Declare PtrSafe Function lineSetTerminal Lib "tapi32" ( _
ByVal hLine As Long, _
ByVal dwAddressID As Long, _
ByVal hCall As Long, _
ByVal dwSelect As Long, _
ByVal dwTerminalModes As Long, _
ByVal dwTerminalID As Long, _
ByVal bEnable As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
lineSetTerminal = ctypes.windll.tapi32.lineSetTerminal
lineSetTerminal.restype = ctypes.c_int
lineSetTerminal.argtypes = [
wintypes.DWORD, # hLine : DWORD
wintypes.DWORD, # dwAddressID : DWORD
wintypes.DWORD, # hCall : DWORD
wintypes.DWORD, # dwSelect : DWORD
wintypes.DWORD, # dwTerminalModes : DWORD
wintypes.DWORD, # dwTerminalID : DWORD
wintypes.DWORD, # bEnable : DWORD
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('TAPI32.dll')
lineSetTerminal = Fiddle::Function.new(
lib['lineSetTerminal'],
[
-Fiddle::TYPE_INT, # hLine : DWORD
-Fiddle::TYPE_INT, # dwAddressID : DWORD
-Fiddle::TYPE_INT, # hCall : DWORD
-Fiddle::TYPE_INT, # dwSelect : DWORD
-Fiddle::TYPE_INT, # dwTerminalModes : DWORD
-Fiddle::TYPE_INT, # dwTerminalID : DWORD
-Fiddle::TYPE_INT, # bEnable : DWORD
],
Fiddle::TYPE_INT)#[link(name = "tapi32")]
extern "system" {
fn lineSetTerminal(
hLine: u32, // DWORD
dwAddressID: u32, // DWORD
hCall: u32, // DWORD
dwSelect: u32, // DWORD
dwTerminalModes: u32, // DWORD
dwTerminalID: u32, // DWORD
bEnable: u32 // DWORD
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("TAPI32.dll")]
public static extern int lineSetTerminal(uint hLine, uint dwAddressID, uint hCall, uint dwSelect, uint dwTerminalModes, uint dwTerminalID, uint bEnable);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TAPI32_lineSetTerminal' -Namespace Win32 -PassThru
# $api::lineSetTerminal(hLine, dwAddressID, hCall, dwSelect, dwTerminalModes, dwTerminalID, bEnable)#uselib "TAPI32.dll"
#func global lineSetTerminal "lineSetTerminal" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; lineSetTerminal hLine, dwAddressID, hCall, dwSelect, dwTerminalModes, dwTerminalID, bEnable ; 戻り値は stat
; hLine : DWORD -> "sptr"
; dwAddressID : DWORD -> "sptr"
; hCall : DWORD -> "sptr"
; dwSelect : DWORD -> "sptr"
; dwTerminalModes : DWORD -> "sptr"
; dwTerminalID : DWORD -> "sptr"
; bEnable : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "TAPI32.dll"
#cfunc global lineSetTerminal "lineSetTerminal" int, int, int, int, int, int, int
; res = lineSetTerminal(hLine, dwAddressID, hCall, dwSelect, dwTerminalModes, dwTerminalID, bEnable)
; hLine : DWORD -> "int"
; dwAddressID : DWORD -> "int"
; hCall : DWORD -> "int"
; dwSelect : DWORD -> "int"
; dwTerminalModes : DWORD -> "int"
; dwTerminalID : DWORD -> "int"
; bEnable : DWORD -> "int"; INT lineSetTerminal(DWORD hLine, DWORD dwAddressID, DWORD hCall, DWORD dwSelect, DWORD dwTerminalModes, DWORD dwTerminalID, DWORD bEnable)
#uselib "TAPI32.dll"
#cfunc global lineSetTerminal "lineSetTerminal" int, int, int, int, int, int, int
; res = lineSetTerminal(hLine, dwAddressID, hCall, dwSelect, dwTerminalModes, dwTerminalID, bEnable)
; hLine : DWORD -> "int"
; dwAddressID : DWORD -> "int"
; hCall : DWORD -> "int"
; dwSelect : DWORD -> "int"
; dwTerminalModes : DWORD -> "int"
; dwTerminalID : DWORD -> "int"
; bEnable : DWORD -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
tapi32 = windows.NewLazySystemDLL("TAPI32.dll")
proclineSetTerminal = tapi32.NewProc("lineSetTerminal")
)
// hLine (DWORD), dwAddressID (DWORD), hCall (DWORD), dwSelect (DWORD), dwTerminalModes (DWORD), dwTerminalID (DWORD), bEnable (DWORD)
r1, _, err := proclineSetTerminal.Call(
uintptr(hLine),
uintptr(dwAddressID),
uintptr(hCall),
uintptr(dwSelect),
uintptr(dwTerminalModes),
uintptr(dwTerminalID),
uintptr(bEnable),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction lineSetTerminal(
hLine: DWORD; // DWORD
dwAddressID: DWORD; // DWORD
hCall: DWORD; // DWORD
dwSelect: DWORD; // DWORD
dwTerminalModes: DWORD; // DWORD
dwTerminalID: DWORD; // DWORD
bEnable: DWORD // DWORD
): Integer; stdcall;
external 'TAPI32.dll' name 'lineSetTerminal';result := DllCall("TAPI32\lineSetTerminal"
, "UInt", hLine ; DWORD
, "UInt", dwAddressID ; DWORD
, "UInt", hCall ; DWORD
, "UInt", dwSelect ; DWORD
, "UInt", dwTerminalModes ; DWORD
, "UInt", dwTerminalID ; DWORD
, "UInt", bEnable ; DWORD
, "Int") ; return: INT●lineSetTerminal(hLine, dwAddressID, hCall, dwSelect, dwTerminalModes, dwTerminalID, bEnable) = DLL("TAPI32.dll", "int lineSetTerminal(dword, dword, dword, dword, dword, dword, dword)")
# 呼び出し: lineSetTerminal(hLine, dwAddressID, hCall, dwSelect, dwTerminalModes, dwTerminalID, bEnable)
# hLine : DWORD -> "dword"
# dwAddressID : DWORD -> "dword"
# hCall : DWORD -> "dword"
# dwSelect : DWORD -> "dword"
# dwTerminalModes : DWORD -> "dword"
# dwTerminalID : DWORD -> "dword"
# bEnable : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "tapi32" fn lineSetTerminal(
hLine: u32, // DWORD
dwAddressID: u32, // DWORD
hCall: u32, // DWORD
dwSelect: u32, // DWORD
dwTerminalModes: u32, // DWORD
dwTerminalID: u32, // DWORD
bEnable: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;proc lineSetTerminal(
hLine: uint32, # DWORD
dwAddressID: uint32, # DWORD
hCall: uint32, # DWORD
dwSelect: uint32, # DWORD
dwTerminalModes: uint32, # DWORD
dwTerminalID: uint32, # DWORD
bEnable: uint32 # DWORD
): int32 {.importc: "lineSetTerminal", stdcall, dynlib: "TAPI32.dll".}pragma(lib, "tapi32");
extern(Windows)
int lineSetTerminal(
uint hLine, // DWORD
uint dwAddressID, // DWORD
uint hCall, // DWORD
uint dwSelect, // DWORD
uint dwTerminalModes, // DWORD
uint dwTerminalID, // DWORD
uint bEnable // DWORD
);ccall((:lineSetTerminal, "TAPI32.dll"), stdcall, Int32,
(UInt32, UInt32, UInt32, UInt32, UInt32, UInt32, UInt32),
hLine, dwAddressID, hCall, dwSelect, dwTerminalModes, dwTerminalID, bEnable)
# hLine : DWORD -> UInt32
# dwAddressID : DWORD -> UInt32
# hCall : DWORD -> UInt32
# dwSelect : DWORD -> UInt32
# dwTerminalModes : DWORD -> UInt32
# dwTerminalID : DWORD -> UInt32
# bEnable : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t lineSetTerminal(
uint32_t hLine,
uint32_t dwAddressID,
uint32_t hCall,
uint32_t dwSelect,
uint32_t dwTerminalModes,
uint32_t dwTerminalID,
uint32_t bEnable);
]]
local tapi32 = ffi.load("tapi32")
-- tapi32.lineSetTerminal(hLine, dwAddressID, hCall, dwSelect, dwTerminalModes, dwTerminalID, bEnable)
-- hLine : DWORD
-- dwAddressID : DWORD
-- hCall : DWORD
-- dwSelect : DWORD
-- dwTerminalModes : DWORD
-- dwTerminalID : DWORD
-- bEnable : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('TAPI32.dll');
const lineSetTerminal = lib.func('__stdcall', 'lineSetTerminal', 'int32_t', ['uint32_t', 'uint32_t', 'uint32_t', 'uint32_t', 'uint32_t', 'uint32_t', 'uint32_t']);
// lineSetTerminal(hLine, dwAddressID, hCall, dwSelect, dwTerminalModes, dwTerminalID, bEnable)
// hLine : DWORD -> 'uint32_t'
// dwAddressID : DWORD -> 'uint32_t'
// hCall : DWORD -> 'uint32_t'
// dwSelect : DWORD -> 'uint32_t'
// dwTerminalModes : DWORD -> 'uint32_t'
// dwTerminalID : DWORD -> 'uint32_t'
// bEnable : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("TAPI32.dll", {
lineSetTerminal: { parameters: ["u32", "u32", "u32", "u32", "u32", "u32", "u32"], result: "i32" },
});
// lib.symbols.lineSetTerminal(hLine, dwAddressID, hCall, dwSelect, dwTerminalModes, dwTerminalID, bEnable)
// hLine : DWORD -> "u32"
// dwAddressID : DWORD -> "u32"
// hCall : DWORD -> "u32"
// dwSelect : DWORD -> "u32"
// dwTerminalModes : DWORD -> "u32"
// dwTerminalID : DWORD -> "u32"
// bEnable : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t lineSetTerminal(
uint32_t hLine,
uint32_t dwAddressID,
uint32_t hCall,
uint32_t dwSelect,
uint32_t dwTerminalModes,
uint32_t dwTerminalID,
uint32_t bEnable);
C, "TAPI32.dll");
// $ffi->lineSetTerminal(hLine, dwAddressID, hCall, dwSelect, dwTerminalModes, dwTerminalID, bEnable);
// hLine : DWORD
// dwAddressID : DWORD
// hCall : DWORD
// dwSelect : DWORD
// dwTerminalModes : DWORD
// dwTerminalID : DWORD
// bEnable : 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 lineSetTerminal(
int hLine, // DWORD
int dwAddressID, // DWORD
int hCall, // DWORD
int dwSelect, // DWORD
int dwTerminalModes, // DWORD
int dwTerminalID, // DWORD
int bEnable // DWORD
);
}@[Link("tapi32")]
lib LibTAPI32
fun lineSetTerminal = lineSetTerminal(
hLine : UInt32, # DWORD
dwAddressID : UInt32, # DWORD
hCall : UInt32, # DWORD
dwSelect : UInt32, # DWORD
dwTerminalModes : UInt32, # DWORD
dwTerminalID : UInt32, # DWORD
bEnable : 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 lineSetTerminalNative = Int32 Function(Uint32, Uint32, Uint32, Uint32, Uint32, Uint32, Uint32);
typedef lineSetTerminalDart = int Function(int, int, int, int, int, int, int);
final lineSetTerminal = DynamicLibrary.open('TAPI32.dll')
.lookupFunction<lineSetTerminalNative, lineSetTerminalDart>('lineSetTerminal');
// hLine : DWORD -> Uint32
// dwAddressID : DWORD -> Uint32
// hCall : DWORD -> Uint32
// dwSelect : DWORD -> Uint32
// dwTerminalModes : DWORD -> Uint32
// dwTerminalID : DWORD -> Uint32
// bEnable : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function lineSetTerminal(
hLine: DWORD; // DWORD
dwAddressID: DWORD; // DWORD
hCall: DWORD; // DWORD
dwSelect: DWORD; // DWORD
dwTerminalModes: DWORD; // DWORD
dwTerminalID: DWORD; // DWORD
bEnable: DWORD // DWORD
): Integer; stdcall;
external 'TAPI32.dll' name 'lineSetTerminal';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "lineSetTerminal"
c_lineSetTerminal :: Word32 -> Word32 -> Word32 -> Word32 -> Word32 -> Word32 -> Word32 -> IO Int32
-- hLine : DWORD -> Word32
-- dwAddressID : DWORD -> Word32
-- hCall : DWORD -> Word32
-- dwSelect : DWORD -> Word32
-- dwTerminalModes : DWORD -> Word32
-- dwTerminalID : DWORD -> Word32
-- bEnable : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let linesetterminal =
foreign "lineSetTerminal"
(uint32_t @-> uint32_t @-> uint32_t @-> uint32_t @-> uint32_t @-> uint32_t @-> uint32_t @-> returning int32_t)
(* hLine : DWORD -> uint32_t *)
(* dwAddressID : DWORD -> uint32_t *)
(* hCall : DWORD -> uint32_t *)
(* dwSelect : DWORD -> uint32_t *)
(* dwTerminalModes : DWORD -> uint32_t *)
(* dwTerminalID : DWORD -> uint32_t *)
(* bEnable : 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 ("lineSetTerminal" line-set-terminal :convention :stdcall) :int32
(h-line :uint32) ; DWORD
(dw-address-id :uint32) ; DWORD
(h-call :uint32) ; DWORD
(dw-select :uint32) ; DWORD
(dw-terminal-modes :uint32) ; DWORD
(dw-terminal-id :uint32) ; DWORD
(b-enable :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $lineSetTerminal = Win32::API::More->new('TAPI32',
'int lineSetTerminal(DWORD hLine, DWORD dwAddressID, DWORD hCall, DWORD dwSelect, DWORD dwTerminalModes, DWORD dwTerminalID, DWORD bEnable)');
# my $ret = $lineSetTerminal->Call($hLine, $dwAddressID, $hCall, $dwSelect, $dwTerminalModes, $dwTerminalID, $bEnable);
# hLine : DWORD -> DWORD
# dwAddressID : DWORD -> DWORD
# hCall : DWORD -> DWORD
# dwSelect : DWORD -> DWORD
# dwTerminalModes : DWORD -> DWORD
# dwTerminalID : DWORD -> DWORD
# bEnable : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- s LINEDEVCAPS
- f lineGetDevCapsW — 指定した回線デバイスの機能や能力を取得する(Unicode版)。