ホーム › Devices.Tapi › linePrepareAddToConference

linePrepareAddToConference

関数

会議通話に追加する相談通話を準備して作成する。

DLLTAPI32.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

// TAPI32.dll  (ANSI / -A)
#include <windows.h>

INT linePrepareAddToConference(
    DWORD hConfCall,
    DWORD* lphConsultCall,
    const LINECALLPARAMS* lpCallParams
);

パラメーター

名前	型	方向	説明
hConfCall	DWORD	in	会議通話へのハンドル。アプリケーションはこの通話の所有者である必要があります。hConfCall の通話状態は connected である必要があります。
lphConsultCall	DWORD*	inout	HCALL ハンドルへのポインター。この場所には、追加対象となる相談通話を識別するハンドルが格納されます。当初は、アプリケーションがこの通話の唯一の所有者となります。
lpCallParams	LINECALLPARAMS*	in	相談通話を確立するときに使用する通話パラメーターを格納した LINECALLPARAMS 構造体へのポインター。特別な通話セットアップパラメーターが不要な場合、このパラメーターには NULL を指定できます。

戻り値の型: INT

公式ドキュメント

linePrepareAddToConference 関数 (tapi.h) は、既存の会議通話に別の通話相手を追加するための準備を行います。

戻り値

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

LINEERR_BEARERMODEUNAVAIL, LINEERR_INVALPOINTER, LINEERR_CALLUNAVAIL, LINEERR_INVALRATE, LINEERR_CONFERENCEFULL, LINEERR_NOMEM, LINEERR_INUSE, LINEERR_NOTOWNER, LINEERR_INVALADDRESSMODE, LINEERR_OPERATIONUNAVAIL, LINEERR_INVALBEARERMODE, LINEERR_OPERATIONFAILED, LINEERR_INVALCALLPARAMS, LINEERR_RATEUNAVAIL, LINEERR_INVALCALLSTATE, LINEERR_RESOURCEUNAVAIL, LINEERR_INVALCONFCALLHANDLE, LINEERR_STRUCTURETOOSMALL, LINEERR_INVALLINESTATE, LINEERR_USERUSERINFOTOOBIG, LINEERR_INVALMEDIAMODE, LINEERR_UNINITIALIZED.

解説(Remarks)

LINEERR_INVALLINESTATE が返された場合、その回線は現在この操作を実行できる状態にありません。現在有効な操作の一覧は、 LINEDEVSTATUS 構造体の dwLineFeatures メンバー (型は LINEFEATURE) で確認できます。( lineGetLineDevStatus を呼び出すと、 LINEDEVSTATUS 内の情報が更新されます。)

会議通話のハンドルは、 lineSetupConference によって取得するか、三者間の会議通話として解決された lineCompleteTransfer によって取得できます。 linePrepareAddToConference 関数は通常、既存の会議通話を onHoldPendingConference 状態にし、後から lineAddToConference で既存の会議通話に追加できる相談通話を作成します。

相談通話は lineDrop を使用して取り消すことができます。また、アプリケーションが lineSwapHold を使用して、相談通話と保留中の会議通話を切り替えられる場合もあります。

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

各言語での呼び出し定義

// TAPI32.dll  (ANSI / -A)
#include <windows.h>

INT linePrepareAddToConference(
    DWORD hConfCall,
    DWORD* lphConsultCall,
    const LINECALLPARAMS* lpCallParams
);

[DllImport("TAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int linePrepareAddToConference(
    uint hConfCall,   // DWORD
    ref uint lphConsultCall,   // DWORD* in/out
    IntPtr lpCallParams   // LINECALLPARAMS*
);

<DllImport("TAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function linePrepareAddToConference(
    hConfCall As UInteger,   ' DWORD
    ByRef lphConsultCall As UInteger,   ' DWORD* in/out
    lpCallParams As IntPtr   ' LINECALLPARAMS*
) As Integer
End Function

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

import ctypes
from ctypes import wintypes

linePrepareAddToConference = ctypes.windll.tapi32.linePrepareAddToConference
linePrepareAddToConference.restype = ctypes.c_int
linePrepareAddToConference.argtypes = [
    wintypes.DWORD,  # hConfCall : DWORD
    ctypes.POINTER(wintypes.DWORD),  # lphConsultCall : DWORD* in/out
    ctypes.c_void_p,  # lpCallParams : LINECALLPARAMS*
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('TAPI32.dll')
linePrepareAddToConference = Fiddle::Function.new(
  lib['linePrepareAddToConference'],
  [
    -Fiddle::TYPE_INT,  # hConfCall : DWORD
    Fiddle::TYPE_VOIDP,  # lphConsultCall : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # lpCallParams : LINECALLPARAMS*
  ],
  Fiddle::TYPE_INT)

#[link(name = "tapi32")]
extern "system" {
    fn linePrepareAddToConference(
        hConfCall: u32,  // DWORD
        lphConsultCall: *mut u32,  // DWORD* in/out
        lpCallParams: *const LINECALLPARAMS  // LINECALLPARAMS*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("TAPI32.dll", CharSet = CharSet.Ansi)]
public static extern int linePrepareAddToConference(uint hConfCall, ref uint lphConsultCall, IntPtr lpCallParams);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TAPI32_linePrepareAddToConference' -Namespace Win32 -PassThru
# $api::linePrepareAddToConference(hConfCall, lphConsultCall, lpCallParams)

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

出力引数:

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