lineMakeCallW

関数

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

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

シグネチャ

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

INT lineMakeCallW(
    DWORD hLine,
    DWORD* lphCall,
    LPCWSTR lpszDestAddress,
    DWORD dwCountryCode,
    const LINECALLPARAMS* lpCallParams
);

パラメーター

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

戻り値の型: INT

公式ドキュメント

lineMakeCallW (Unicode) 関数 (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 メッセージがアプリケーションに送信され、コールの進行状況が通知されます。実際には固定された 1 つの遷移順序を保証できないため、一般的に有効なコール状態の遷移順序は規定されていません。典型的な順序では、コールは dialtone、dialing、proceeding、ringback を経て connected へと遷移します。ダイヤルを行わない回線では、通常、コールは直接 connected 状態に遷移します。

アプリケーションは、指定した回線デバイス上の発信アドレスを指定することもできます。スイッチ上のすべてのステーションを単一の回線デバイス上のアドレスとしてモデル化するサービスプロバイダーでは、アプリケーションは 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  (Unicode / -W)
#include <windows.h>

INT lineMakeCallW(
    DWORD hLine,
    DWORD* lphCall,
    LPCWSTR lpszDestAddress,
    DWORD dwCountryCode,
    const LINECALLPARAMS* lpCallParams
);

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

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

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

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('TAPI32.dll')
lineMakeCallW = Fiddle::Function.new(
  lib['lineMakeCallW'],
  [
    -Fiddle::TYPE_INT,  # hLine : DWORD
    Fiddle::TYPE_VOIDP,  # lphCall : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # lpszDestAddress : LPCWSTR
    -Fiddle::TYPE_INT,  # dwCountryCode : DWORD
    Fiddle::TYPE_VOIDP,  # lpCallParams : LINECALLPARAMS*
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

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

出力引数:

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