lineMakeCall

関数

指定アドレスへ発信して新しい通話を開始する。

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

シグネチャ

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

INT lineMakeCall(
    DWORD hLine,
    DWORD* lphCall,
    LPCSTR lpszDestAddress,
    DWORD dwCountryCode,
    const LINECALLPARAMS* lpCallParams
);

パラメーター

名前	型	方向	説明
hLine	DWORD	in	通話の発信に使用する、オープン済みの回線デバイスへのハンドル。
lphCall	DWORD*	inout	HCALL ハンドルへのポインター。このハンドルは、 lineMakeCall 関数が正常に完了したことを示す LINE_REPLY メッセージをアプリケーションが受信した後にのみ有効です。この通話に対して他のテレフォニー操作を呼び出す際は、このハンドルを使用して通話を識別します。アプリケーションは当初、この通話の唯一の所有者です。関数がエラーを返した場合 (同期的に返された場合も、応答メッセージによって非同期に返された場合も)、このハンドルは無効です。
lpszDestAddress	LPCSTR	in	宛先アドレスへのポインター。標準のダイヤル可能番号形式に従います。ホットフォンのようにダイヤルを行わないアドレスの場合、またはすべてのダイヤルを lineDial で行う場合は、このポインターに NULL を指定できます。後者の場合、 lineMakeCall は使用可能なコールアピアランスを割り当てます。これは通常、ダイヤルが開始されるまで dialtone 状態のままになります。逆多重化機能を備えたサービスプロバイダーでは、アプリケーションが複数のアドレスを一度に指定できる場合があります。
dwCountryCode	DWORD	in	着信側の国または地域コード。値に 0 を指定した場合は、実装による既定値が使用されます。
lpCallParams	LINECALLPARAMS*	in	LINECALLPARAMS 構造体へのポインター。この構造体により、アプリケーションは通話の設定方法を指定できます。NULL を指定した場合は、既定の 3.1 kHz 音声通話が確立され、回線上の発信元アドレスが任意に選択されます。この構造体では、通話のベアラーモード、データレート、想定されるメディアモード、発信元アドレス、発信者番号情報の通知抑止、ダイヤルパラメーターなどの要素を選択できます。

戻り値の型: INT

公式ドキュメント

lineMakeCall 関数 (tapi.h) は、指定した回線で、指定した宛先アドレスに対して通話を発信します。

戻り値

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

LINEERR_ADDRESSBLOCKED、LINEERR_INVALLINEHANDLE、LINEERR_BEARERMODEUNAVAIL、LINEERR_INVALLINESTATE、LINEERR_CALLUNAVAIL、LINEERR_INVALMEDIAMODE、LINEERR_DIALBILLING、LINEERR_INVALPARAM、LINEERR_DIALDIALTONE、LINEERR_INVALPOINTER、LINEERR_DIALPROMPT、LINEERR_INVALRATE、LINEERR_DIALQUIET、LINEERR_NOMEM、LINEERR_INUSE、LINEERR_OPERATIONFAILED、LINEERR_INVALADDRESS、LINEERR_OPERATIONUNAVAIL、LINEERR_INVALADDRESSID、LINEERR_RATEUNAVAIL、LINEERR_INVALADDRESSMODE、LINEERR_RESOURCEUNAVAIL、LINEERR_INVALBEARERMODE、LINEERR_STRUCTURETOOSMALL、LINEERR_INVALCALLPARAMS、LINEERR_UNINITIALIZED、LINEERR_INVALCOUNTRYCODE、LINEERR_USERUSERINFOTOOBIG。

解説(Remarks)

LINEERR_INVALLINESTATE が返された場合、その回線は現在この操作を実行できる状態にありません。現時点で有効な操作の一覧は、 LINEDEVSTATUS 構造体の dwLineFeatures メンバー (LINEFEATURE_ 型) で確認できます。 lineGetLineDevStatus を呼び出すと、 LINEDEVSTATUS の情報が更新されます。LINEERR_DIALBILLING、LINEERR_DIALQUIET、LINEERR_DIALDIALTONE、LINEERR_DIALPROMPT のいずれかが返された場合、 lineMakeCall が通常実行する処理はいずれも行われていません。たとえば、問題のある文字より前のダイヤル可能アドレスもダイヤルされておらず、フックスイッチの状態も変化していません。

ダイヤルが完了すると、通常は複数の LINE_CALLSTATE メッセージがアプリケーションに送信され、通話の進行状況が通知されます。実際には固定された遷移順序を保証できないため、一般的に有効な通話状態の遷移順序は規定されていません。典型的な遷移順序としては、通話が dialtone、dialing、proceeding、ringback を経て connected に遷移する場合があります。ダイヤルを行わない回線では、通常、通話は直接 connected 状態に遷移します。

アプリケーションは、指定した回線デバイス上の発信元アドレスを指定することもできます。交換機上のすべてのステーションを 1 つの回線デバイス上のアドレスとしてモデル化するサービスプロバイダーでは、アプリケーションは lineMakeCall を使用してこれらの任意のステーションから通話を発信できます。

通話パラメーターを使用すると、アプリケーションは音声以外の通話を発信したり、既定では利用できない特別な通話設定オプションを要求したりできます。

アプリケーションは、 lineMakeCall で部分的にダイヤルし、 lineDial で引き続きダイヤルすることができます。部分ダイヤルの詳細については、lineDial および TSPI_lineMakeCall を参照してください。通話の発信試行を中止するには、 lineDrop を使用します。

lineMakeCall が成功の応答メッセージをアプリケーションに返した後、通話の現在の状態を示す LINE_CALLSTATE メッセージがアプリケーションに送信されます。この状態は必ずしも LINECALLSTATE_DIALTONE とは限りません。

この関数は、データを暗号化されていない形式でネットワーク上に送信する場合があります。そのため、ネットワークを盗聴している第三者がデータを読み取れる可能性があります。このメソッドを使用する前に、データを平文で送信することによるセキュリティ上のリスクを検討してください。

注意 TAPI は、LINE_REPLY メッセージが返されるときに、lphCall が参照するバッファーに返却データを書き込みます。つまり、LINE_REPLY メッセージが返されるまでバッファーは有効なままである必要があります。そうでない場合、データの破損や例外が発生する可能性があります。

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

[DllImport("TAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int lineMakeCall(
    uint hLine,   // DWORD
    ref uint lphCall,   // DWORD* in/out
    [MarshalAs(UnmanagedType.LPStr)] string lpszDestAddress,   // LPCSTR
    uint dwCountryCode,   // DWORD
    IntPtr lpCallParams   // LINECALLPARAMS*
);

<DllImport("TAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function lineMakeCall(
    hLine As UInteger,   ' DWORD
    ByRef lphCall As UInteger,   ' DWORD* in/out
    <MarshalAs(UnmanagedType.LPStr)> lpszDestAddress As String,   ' LPCSTR
    dwCountryCode As UInteger,   ' DWORD
    lpCallParams As IntPtr   ' LINECALLPARAMS*
) As Integer
End Function

' hLine : DWORD
' lphCall : DWORD* in/out
' lpszDestAddress : LPCSTR
' dwCountryCode : DWORD
' lpCallParams : LINECALLPARAMS*
Declare PtrSafe Function lineMakeCall Lib "tapi32" ( _
    ByVal hLine As Long, _
    ByRef lphCall As Long, _
    ByVal lpszDestAddress As String, _
    ByVal dwCountryCode 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

lineMakeCall = ctypes.windll.tapi32.lineMakeCall
lineMakeCall.restype = ctypes.c_int
lineMakeCall.argtypes = [
    wintypes.DWORD,  # hLine : DWORD
    ctypes.POINTER(wintypes.DWORD),  # lphCall : DWORD* in/out
    wintypes.LPCSTR,  # lpszDestAddress : LPCSTR
    wintypes.DWORD,  # dwCountryCode : DWORD
    ctypes.c_void_p,  # lpCallParams : LINECALLPARAMS*
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('TAPI32.dll')
lineMakeCall = Fiddle::Function.new(
  lib['lineMakeCall'],
  [
    -Fiddle::TYPE_INT,  # hLine : DWORD
    Fiddle::TYPE_VOIDP,  # lphCall : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # lpszDestAddress : LPCSTR
    -Fiddle::TYPE_INT,  # dwCountryCode : DWORD
    Fiddle::TYPE_VOIDP,  # lpCallParams : LINECALLPARAMS*
  ],
  Fiddle::TYPE_INT)

#[link(name = "tapi32")]
extern "system" {
    fn lineMakeCall(
        hLine: u32,  // DWORD
        lphCall: *mut u32,  // DWORD* in/out
        lpszDestAddress: *const u8,  // LPCSTR
        dwCountryCode: u32,  // DWORD
        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 lineMakeCall(uint hLine, ref uint lphCall, [MarshalAs(UnmanagedType.LPStr)] string lpszDestAddress, uint dwCountryCode, IntPtr lpCallParams);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TAPI32_lineMakeCall' -Namespace Win32 -PassThru
# $api::lineMakeCall(hLine, lphCall, lpszDestAddress, dwCountryCode, lpCallParams)

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

出力引数:

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