lineMakeCallA

関数

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

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

シグネチャ

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

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

パラメーター

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

戻り値の型: INT

公式ドキュメント

lineMakeCall 関数は、指定した回線上で、指定した宛先アドレスに対して通話を発信します。既定の呼設定パラメーター以外を要求する場合は、呼パラメーターを任意で指定できます。(lineMakeCallA)

戻り値

関数が非同期に完了する場合は正の要求識別子を、エラーが発生した場合は負のエラー番号を返します。対応する 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 状態に遷移します。

アプリケーションは、指定した回線デバイス上の発信アドレスを指定することもできます。スイッチ上のすべての局 (station) を単一の回線デバイス上のアドレスとしてモデル化するサービスプロバイダーでは、アプリケーションは lineMakeCall を使用してこれらのいずれの局からでも通話を発信できます。

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

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

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

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

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

メモ

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

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

[DllImport("TAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int lineMakeCallA(
    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 lineMakeCallA(
    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 lineMakeCallA 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

lineMakeCallA = ctypes.windll.tapi32.lineMakeCallA
lineMakeCallA.restype = ctypes.c_int
lineMakeCallA.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')
lineMakeCallA = Fiddle::Function.new(
  lib['lineMakeCallA'],
  [
    -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 lineMakeCallA(
        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 lineMakeCallA(uint hLine, ref uint lphCall, [MarshalAs(UnmanagedType.LPStr)] string lpszDestAddress, uint dwCountryCode, IntPtr lpCallParams);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TAPI32_lineMakeCallA' -Namespace Win32 -PassThru
# $api::lineMakeCallA(hLine, lphCall, lpszDestAddress, dwCountryCode, lpCallParams)

#uselib "TAPI32.dll"
#func global lineMakeCallA "lineMakeCallA" sptr, sptr, sptr, sptr, sptr
; lineMakeCallA 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 lineMakeCallA "lineMakeCallA" int, var, str, int, var
; res = lineMakeCallA(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 lineMakeCallA "lineMakeCallA" int, sptr, str, int, sptr
; res = lineMakeCallA(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(変数))。