lineSetupTransfer

関数

通話の転送を準備し、相談用の通話を作成する。

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

シグネチャ

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

INT lineSetupTransfer(
    DWORD hCall,
    DWORD* lphConsultCall,
    const LINECALLPARAMS* lpCallParams
);

パラメーター

名前	型	方向	説明
hCall	DWORD	in	転送する通話へのハンドル。アプリケーションはその通話の所有者である必要があります。hCall の通話状態は connected である必要があります。
lphConsultCall	DWORD*	inout	hCall ハンドルへのポインター。この場所には、一時的な相談通話 (consultation call) を識別するハンドルが格納されます。転送用に通話を設定すると、相談通話が自動的に割り当てられ、 lineDial によって通話の新しい転送先に対応するアドレスをダイヤルできるようになります。発信側は、転送を完了する前にこの相談通話で会話を行うことができます。hConsultCall の通話状態は該当しません。この転送手順は、一部の回線デバイスでは有効でない場合があります。アプリケーションは、新しい相談通話を無視し、既存の保留中の通話の保留を解除して ( lineUnhold を使用)、転送先を指定する必要がある場合があります。アドレス間の通話転送をサポートする交換機では、相談通話は転送対象の通話とは異なるアドレス上に存在できます。また、相談通話を lineMakeCall によって転送先への完全に新しい通話として設定しなければならない場合もあります。どの形式の転送が利用できるかは、その通話のアドレス機能 (address capabilities) に示されます。
lpCallParams	LINECALLPARAMS*	in	相談通話を確立するときに使用する通話パラメーターを格納した LINECALLPARAMS 構造体へのポインター。特別な通話設定パラメーターが不要な場合、このパラメーターには NULL を設定できます。

名前

型

方向

説明

hCall

DWORD

転送する通話へのハンドル。アプリケーションはその通話の所有者である必要があります。hCall の通話状態は connected である必要があります。

lphConsultCall

DWORD*

inout

hCall ハンドルへのポインター。この場所には、一時的な相談通話 (consultation call) を識別するハンドルが格納されます。転送用に通話を設定すると、相談通話が自動的に割り当てられ、 lineDial によって通話の新しい転送先に対応するアドレスをダイヤルできるようになります。発信側は、転送を完了する前にこの相談通話で会話を行うことができます。hConsultCall の通話状態は該当しません。

この転送手順は、一部の回線デバイスでは有効でない場合があります。アプリケーションは、新しい相談通話を無視し、既存の保留中の通話の保留を解除して ( lineUnhold を使用)、転送先を指定する必要がある場合があります。アドレス間の通話転送をサポートする交換機では、相談通話は転送対象の通話とは異なるアドレス上に存在できます。また、相談通話を lineMakeCall によって転送先への完全に新しい通話として設定しなければならない場合もあります。どの形式の転送が利用できるかは、その通話のアドレス機能 (address capabilities) に示されます。

lpCallParams

LINECALLPARAMS*

相談通話を確立するときに使用する通話パラメーターを格納した LINECALLPARAMS 構造体へのポインター。特別な通話設定パラメーターが不要な場合、このパラメーターには NULL を設定できます。

戻り値の型: INT

公式ドキュメント

lineSetupTransfer 関数 (tapi.h) は、hCall パラメーターで指定された通話の転送を開始します。

戻り値

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

LINEERR_BEARERMODEUNAVAIL、LINEERR_INVALRATE、LINEERR_CALLUNAVAIL、LINEERR_NOMEM、LINEERR_INUSE、LINEERR_NOTOWNER、LINEERR_INVALADDRESSMODE、LINEERR_OPERATIONFAILED、LINEERR_INVALBEARERMODE、LINEERR_OPERATIONUNAVAIL、LINEERR_INVALCALLHANDLE、LINEERR_RATEUNAVAIL、LINEERR_INVALCALLPARAMS、LINEERR_RESOURCEUNAVAIL、LINEERR_INVALCALLSTATE、LINEERR_STRUCTURETOOSMALL、LINEERR_INVALLINESTATE、LINEERR_UNINITIALIZED、LINEERR_INVALMEDIAMODE、LINEERR_USERUSERINFOTOOBIG、LINEERR_INVALPOINTER。

解説(Remarks)

lineSetupTransfer 関数は、hCall で指定された通話の転送を設定します。転送の設定フェーズでは相談通話が確立され、転送対象の通話を保留にしたまま、アプリケーションが転送先 (転送される相手) のアドレスを交換機に送信できるようになります。この新しい通話は相談通話 (hConsultCall) と呼ばれ、元の通話とは独立して切断したり操作したりできます。

相談通話が dialtone の通話状態に達すると、アプリケーションは転送先アドレスをダイヤルしてその進行状況を追跡するか、既存の通話の保留を解除することで、通話の転送を進めることができます。選択した転送先への元の通話の転送は、 lineCompleteTransfer を使用して完了します。

相談通話が存在する間、元の通話は通常 onholdPendingTransfer 状態に遷移します。アプリケーションは、 lineSwapHold を使用して相談通話と元の通話を切り替えられる場合があります。相談通話は、それに対して lineDrop を呼び出すことでキャンセルできます。相談通話を切断すると、元の通話は通常 connected 状態に戻ります。元の通話の通話状態が onholdPendingTransfer である場合は、 lineUnhold 関数を使用して通話を復帰させることができます。この場合、相談通話の通話状態は idle に設定されます。

アプリケーションは、 lineBlindTransfer を使用することで、途中の相談通話を扱うことなく 1 ステップで通話を転送することもできます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 lineSetupTransfer(
    DWORD hCall,
    DWORD* lphConsultCall,
    const LINECALLPARAMS* lpCallParams
);

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

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

' hCall : DWORD
' lphConsultCall : DWORD* in/out
' lpCallParams : LINECALLPARAMS*
Declare PtrSafe Function lineSetupTransfer Lib "tapi32" ( _
    ByVal hCall 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

lineSetupTransfer = ctypes.windll.tapi32.lineSetupTransfer
lineSetupTransfer.restype = ctypes.c_int
lineSetupTransfer.argtypes = [
    wintypes.DWORD,  # hCall : 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')
lineSetupTransfer = Fiddle::Function.new(
  lib['lineSetupTransfer'],
  [
    -Fiddle::TYPE_INT,  # hCall : DWORD
    Fiddle::TYPE_VOIDP,  # lphConsultCall : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # lpCallParams : LINECALLPARAMS*
  ],
  Fiddle::TYPE_INT)

#[link(name = "tapi32")]
extern "system" {
    fn lineSetupTransfer(
        hCall: 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 lineSetupTransfer(uint hCall, ref uint lphConsultCall, IntPtr lpCallParams);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TAPI32_lineSetupTransfer' -Namespace Win32 -PassThru
# $api::lineSetupTransfer(hCall, lphConsultCall, lpCallParams)

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

出力引数:

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