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

lineAddToConference

関数
相談通話を会議通話に追加して参加させる。
DLLTAPI32.dll呼出規約winapi
📘 Microsoft Learn (日本語) · English

シグネチャ

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

INT lineAddToConference(
    DWORD hConfCall,
    DWORD hConsultCall
);

パラメーター

名前型方向説明
hConfCallDWORDin会議通話へのハンドル。アプリケーションはこの通話の所有者である必要があります。会議通話に対する監視 (メディア、トーン、桁) は hConfCall にのみ適用され、個々の参加通話には適用されません。hConfCall の通話状態は onHoldPendingConference または onHold である必要があります。
hConsultCallDWORDin会議通話に追加する通話へのハンドル。アプリケーションはこの通話の所有者である必要があります。この通話は、他の会議の親であったり、いずれかの会議の参加者であったりすることはできません。 LINEADDRESSCAPS に示されるデバイス機能によっては、hConsultCall は必ずしも lineSetupConference または linePrepareAddToConference を使用して確立されている必要はありません。hConsultCall の通話状態は connected、onHold、proceeding、または ringback である必要があります。多くの PBX では、通話が実際に応答される前に会議へ追加することが許可されています。

戻り値の型: INT

公式ドキュメント

lineAddToConference 関数は、hConsultCall で指定された通話を、hConfCall で指定された会議通話に追加します。

戻り値

関数が非同期に完了した場合は正の要求識別子を返し、エラーが発生した場合は負のエラー番号を返します。対応する LINE_REPLY メッセージの dwParam2 パラメーターは、関数が成功した場合は 0、エラーが発生した場合は負のエラー番号になります。返される可能性のある値は次のとおりです。

LINEERR_CONFERENCEFULL、LINEERR_NOTOWNER、LINEERR_INVALCONFCALLHANDLE、LINEERR_OPERATIONUNAVAIL、LINEERR_INVALCALLHANDLE、LINEERR_OPERATIONFAILED、LINEERR_INVALCALLSTATE、LINEERR_RESOURCEUNAVAIL、LINEERR_NOMEM、LINEERR_UNINITIALIZED。

解説(Remarks)

LINEERR_INVALCALLHANDLE が返された場合は、追加する通話に指定された通話ハンドルが無効である、hConsultCall が他の会議の親であるか、既にいずれかの会議の参加者である、その他の理由で hConsultCall を追加できない (たとえば、 lineSetupConference または linePrepareAddToConference を使用して確立されている必要がある)、あるいは hConsultCall と hConfCall が異なる開かれた回線上の通話である、のいずれかです。

追加された相手の通話ハンドルは、通話を会議に追加した後も有効なままです。その状態は通常 conferenced に変わり、会議通話の状態は通常 connected になります。 lineGetConfRelatedCalls を使用すると、指定した通話と同じ会議通話に含まれる通話ハンドルの一覧を取得できます。指定する通話は、会議通話または会議通話の参加通話のいずれかです。アプリケーションがまだハンドルを持っていない通話については新しいハンドルが生成され、アプリケーションにはそれらの通話に対する監視特権が与えられます。個々の参加通話のハンドルは、後で lineRemoveFromConference を使用してその相手を会議通話から削除するために使用できます。

lineGetConfRelatedCalls を lineAddToConference の直後に呼び出した場合、関連する通話の完全な一覧が返されないことがあります。これは、通話が LINECALLSTATE_CONFERENCED に入ったことを示す LINE_CALLSTATE メッセージを受信するまで、TAPI がその通話を実際に会議の一部であるとは見なさない (つまり、conferenced 状態がサービスプロバイダーによって確認される) ためです。アプリケーションが LINE_CALLSTATE メッセージを受信した後は、 lineGetConfRelatedCalls は完全な情報を返します。

注意 会議に含まれるすべての通話は、同じ開かれた回線上に存在する必要があります。
会議に参加している通話の通話状態は、互いに独立してはいません。たとえば、会議通話を切断すると、参加しているすべての通話が自動的にアイドル状態になることがあります。アプリケーションは、どのような形式の会議からの削除が利用できるかを判断するために、回線のデバイス機能を確認する必要があります。アプリケーションは、関係する通話に何が起きたかを判断するために LINE_CALLSTATE メッセージを追跡する必要があります。

会議通話は、 lineSetupConference または lineCompleteTransfer のいずれかによって確立されます。会議に追加される通話は、通常 lineSetupConference または linePrepareAddToConference を使用して確立されます。一部の交換機では任意の通話を会議に追加でき、そのような通話は lineMakeCall を使用してセットアップされ、(ハード) 保留中である場合があります。アプリケーションは、許可されている操作を判断するために LINEADDRESSCAPS 構造体の dwAddrCapFlags メンバーを調べることができます。

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

各言語での呼び出し定義

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

INT lineAddToConference(
    DWORD hConfCall,
    DWORD hConsultCall
);
[DllImport("TAPI32.dll", ExactSpelling = true)]
static extern int lineAddToConference(
    uint hConfCall,   // DWORD
    uint hConsultCall   // DWORD
);
<DllImport("TAPI32.dll", ExactSpelling:=True)>
Public Shared Function lineAddToConference(
    hConfCall As UInteger,   ' DWORD
    hConsultCall As UInteger   ' DWORD
) As Integer
End Function
' hConfCall : DWORD
' hConsultCall : DWORD
Declare PtrSafe Function lineAddToConference Lib "tapi32" ( _
    ByVal hConfCall As Long, _
    ByVal hConsultCall As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

lineAddToConference = ctypes.windll.tapi32.lineAddToConference
lineAddToConference.restype = ctypes.c_int
lineAddToConference.argtypes = [
    wintypes.DWORD,  # hConfCall : DWORD
    wintypes.DWORD,  # hConsultCall : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('TAPI32.dll')
lineAddToConference = Fiddle::Function.new(
  lib['lineAddToConference'],
  [
    -Fiddle::TYPE_INT,  # hConfCall : DWORD
    -Fiddle::TYPE_INT,  # hConsultCall : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "tapi32")]
extern "system" {
    fn lineAddToConference(
        hConfCall: u32,  // DWORD
        hConsultCall: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("TAPI32.dll")]
public static extern int lineAddToConference(uint hConfCall, uint hConsultCall);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TAPI32_lineAddToConference' -Namespace Win32 -PassThru
# $api::lineAddToConference(hConfCall, hConsultCall)
#uselib "TAPI32.dll"
#func global lineAddToConference "lineAddToConference" sptr, sptr
; lineAddToConference hConfCall, hConsultCall   ; 戻り値は stat
; hConfCall : DWORD -> "sptr"
; hConsultCall : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "TAPI32.dll"
#cfunc global lineAddToConference "lineAddToConference" int, int
; res = lineAddToConference(hConfCall, hConsultCall)
; hConfCall : DWORD -> "int"
; hConsultCall : DWORD -> "int"
; INT lineAddToConference(DWORD hConfCall, DWORD hConsultCall)
#uselib "TAPI32.dll"
#cfunc global lineAddToConference "lineAddToConference" int, int
; res = lineAddToConference(hConfCall, hConsultCall)
; hConfCall : DWORD -> "int"
; hConsultCall : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	tapi32 = windows.NewLazySystemDLL("TAPI32.dll")
	proclineAddToConference = tapi32.NewProc("lineAddToConference")
)

// hConfCall (DWORD), hConsultCall (DWORD)
r1, _, err := proclineAddToConference.Call(
	uintptr(hConfCall),
	uintptr(hConsultCall),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function lineAddToConference(
  hConfCall: DWORD;   // DWORD
  hConsultCall: DWORD   // DWORD
): Integer; stdcall;
  external 'TAPI32.dll' name 'lineAddToConference';
result := DllCall("TAPI32\lineAddToConference"
    , "UInt", hConfCall   ; DWORD
    , "UInt", hConsultCall   ; DWORD
    , "Int")   ; return: INT
●lineAddToConference(hConfCall, hConsultCall) = DLL("TAPI32.dll", "int lineAddToConference(dword, dword)")
# 呼び出し: lineAddToConference(hConfCall, hConsultCall)
# hConfCall : DWORD -> "dword"
# hConsultCall : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "tapi32" fn lineAddToConference(
    hConfCall: u32, // DWORD
    hConsultCall: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc lineAddToConference(
    hConfCall: uint32,  # DWORD
    hConsultCall: uint32  # DWORD
): int32 {.importc: "lineAddToConference", stdcall, dynlib: "TAPI32.dll".}
pragma(lib, "tapi32");
extern(Windows)
int lineAddToConference(
    uint hConfCall,   // DWORD
    uint hConsultCall   // DWORD
);
ccall((:lineAddToConference, "TAPI32.dll"), stdcall, Int32,
      (UInt32, UInt32),
      hConfCall, hConsultCall)
# hConfCall : DWORD -> UInt32
# hConsultCall : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t lineAddToConference(
    uint32_t hConfCall,
    uint32_t hConsultCall);
]]
local tapi32 = ffi.load("tapi32")
-- tapi32.lineAddToConference(hConfCall, hConsultCall)
-- hConfCall : DWORD
-- hConsultCall : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('TAPI32.dll');
const lineAddToConference = lib.func('__stdcall', 'lineAddToConference', 'int32_t', ['uint32_t', 'uint32_t']);
// lineAddToConference(hConfCall, hConsultCall)
// hConfCall : DWORD -> 'uint32_t'
// hConsultCall : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("TAPI32.dll", {
  lineAddToConference: { parameters: ["u32", "u32"], result: "i32" },
});
// lib.symbols.lineAddToConference(hConfCall, hConsultCall)
// hConfCall : DWORD -> "u32"
// hConsultCall : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t lineAddToConference(
    uint32_t hConfCall,
    uint32_t hConsultCall);
C, "TAPI32.dll");
// $ffi->lineAddToConference(hConfCall, hConsultCall);
// hConfCall : DWORD
// hConsultCall : 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 lineAddToConference(
        int hConfCall,   // DWORD
        int hConsultCall   // DWORD
    );
}
@[Link("tapi32")]
lib LibTAPI32
  fun lineAddToConference = lineAddToConference(
    hConfCall : UInt32,   # DWORD
    hConsultCall : 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 lineAddToConferenceNative = Int32 Function(Uint32, Uint32);
typedef lineAddToConferenceDart = int Function(int, int);
final lineAddToConference = DynamicLibrary.open('TAPI32.dll')
    .lookupFunction<lineAddToConferenceNative, lineAddToConferenceDart>('lineAddToConference');
// hConfCall : DWORD -> Uint32
// hConsultCall : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function lineAddToConference(
  hConfCall: DWORD;   // DWORD
  hConsultCall: DWORD   // DWORD
): Integer; stdcall;
  external 'TAPI32.dll' name 'lineAddToConference';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "lineAddToConference"
  c_lineAddToConference :: Word32 -> Word32 -> IO Int32
-- hConfCall : DWORD -> Word32
-- hConsultCall : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let lineaddtoconference =
  foreign "lineAddToConference"
    (uint32_t @-> uint32_t @-> returning int32_t)
(* hConfCall : DWORD -> uint32_t *)
(* hConsultCall : 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 ("lineAddToConference" line-add-to-conference :convention :stdcall) :int32
  (h-conf-call :uint32)   ; DWORD
  (h-consult-call :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $lineAddToConference = Win32::API::More->new('TAPI32',
    'int lineAddToConference(DWORD hConfCall, DWORD hConsultCall)');
# my $ret = $lineAddToConference->Call($hConfCall, $hConsultCall);
# hConfCall : DWORD -> DWORD
# hConsultCall : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目