ホーム › Devices.Tapi › linePrepareAddToConferenceW

linePrepareAddToConferenceW

関数

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

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

シグネチャ

// TAPI32.dll  (Unicode / -W)
#include <windows.h>

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

パラメーター

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

戻り値の型: INT

公式ドキュメント

linePrepareAddToConferenceW (Unicode) 関数 (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 によって相談通話と保留中の会議通話を切り替えられる場合もあります。

メモ

tapi.h ヘッダーは linePrepareAddToConference を、UNICODE プリプロセッサー定数の定義に応じてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコード中立のエイリアスの使用とエンコード中立でないコードを混在させると、不一致が生じてコンパイルエラーまたは実行時エラーの原因になる可能性があります。詳細については、「Conventions for Function Prototypes」を参照してください。

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

各言語での呼び出し定義

// TAPI32.dll  (Unicode / -W)
#include <windows.h>

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

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

<DllImport("TAPI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function linePrepareAddToConferenceW(
    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 linePrepareAddToConferenceW Lib "tapi32" ( _
    ByVal hConfCall As Long, _
    ByRef lphConsultCall As Long, _
    ByVal lpCallParams As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

linePrepareAddToConferenceW = ctypes.windll.tapi32.linePrepareAddToConferenceW
linePrepareAddToConferenceW.restype = ctypes.c_int
linePrepareAddToConferenceW.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')
linePrepareAddToConferenceW = Fiddle::Function.new(
  lib['linePrepareAddToConferenceW'],
  [
    -Fiddle::TYPE_INT,  # hConfCall : DWORD
    Fiddle::TYPE_VOIDP,  # lphConsultCall : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # lpCallParams : LINECALLPARAMS*
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "tapi32")]
extern "system" {
    fn linePrepareAddToConferenceW(
        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.Unicode)]
public static extern int linePrepareAddToConferenceW(uint hConfCall, ref uint lphConsultCall, IntPtr lpCallParams);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TAPI32_linePrepareAddToConferenceW' -Namespace Win32 -PassThru
# $api::linePrepareAddToConferenceW(hConfCall, lphConsultCall, lpCallParams)

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

出力引数:

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