Win32 API 日本語リファレンス
ホーム › Devices.Tapi › lineDial

lineDial

関数
接続済みの通話で指定アドレスへダイヤルする。
DLLTAPI32.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

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

INT lineDial(
    DWORD hCall,
    LPCSTR lpszDestAddress,
    DWORD dwCountryCode
);

パラメーター

名前型方向説明
hCallDWORDin番号をダイヤルする対象の通話へのハンドル。アプリケーションはその通話の所有者である必要があります。hCall の通話状態は、idle と disconnected を除く任意の状態を取ることができます。
lpszDestAddressLPCSTRin標準のダイヤル可能な番号形式を使用してダイヤルする宛先。
dwCountryCodeDWORDin宛先の国または地域コード。これは、宛先アドレスに対するコール進行プロトコルを選択するために実装によって使用されます。値 0 を指定した場合は、サービスプロバイダーが定義した既定のコール進行プロトコルが使用されます。

戻り値の型: INT

公式ドキュメント

lineDial 関数 (tapi.h) は、指定された通話で、指定されたダイヤル可能な番号をダイヤルします。

戻り値

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

LINEERR_ADDRESSBLOCKED, LINEERR_INVALPOINTER, LINEERR_DIALBILLING, LINEERR_NOMEM, LINEERR_DIALDIALTONE, LINEERR_NOTOWNER, LINEERR_DIALPROMPT, LINEERR_OPERATIONFAILED, LINEERR_DIALQUIET, LINEERR_OPERATIONUNAVAIL, LINEERR_INVALCALLHANDLE, LINEERR_RESOURCEUNAVAIL, LINEERR_INVALCALLSTATE, LINEERR_UNINITIALIZED, LINEERR_INVALCOUNTRYCODE.

解説(Remarks)

LINEERR_INVALADDRESS が返された場合、ダイヤルは一切行われていません。LINEERR_DIALBILLING、LINEERR_DIALQUIET、LINEERR_DIALDIALTONE、または LINEERR_DIALPROMPT が返された場合、通常 lineDial によって実行される処理はいずれも行われていません。たとえば、問題のある文字より前のダイヤル可能なアドレスもダイヤルされておらず、フックスイッチの状態も変化していません。

lineDial 関数は、既存のコールアピアランスでダイヤルを行うために使用します。たとえば、転送または会議のために通話が設定されると、コンサルテーション通話が自動的に割り当てられ、このコンサルテーション通話のダイヤルを行うために lineDial 関数を使用します。回線のデバイス機能が許可している場合、 lineDial 関数は多段階ダイヤルの過程で複数回呼び出すことができます。また、1 つのダイヤル文字列内に CRLF で区切って複数のアドレスを指定することもできます。逆多重化 (inverse multiplexing) を提供するサービスプロバイダーは、各アドレスに対して個別の物理的な通話を確立し、それらすべての通話の集合を表す 1 つの通話ハンドルをアプリケーションに返すことができます。すべてのアドレスは同じ国または地域コードを使用します。

ダイヤルは、アドレスがサービスプロバイダーに渡された時点で完了と見なされます。通話が最終的に接続された時点ではありません。逆多重化を提供するサービスプロバイダーは、複数のアドレスを一度に指定できるようにすることができます。サービスプロバイダーは、通話の進行状況をアプリケーションに通知するために LINE_CALLSTATE メッセージを送信します。通話の確立中に発信の試行を中止するには、呼び出し元のアプリケーションで lineDrop を使用してください。

アプリケーションは、 lineDial 関数の lpszDestAddress パラメーターに空文字列のアドレスを設定して、ダイヤルが完了したことを示すことができます。ただしこれは、それ以前の lineMakeCall および lineDial 関数の呼び出しで lpszDestAddress に指定した文字列がセミコロンで終了していた場合に限ります。

lineDial 関数は、部分ダイヤル (partial dialing) にも使用できます。部分ダイヤルを使用して通話を開始するには、アプリケーションは lineMakeCall を呼び出し、部分ダイヤル文字列を指定します。部分ダイヤル文字列とは、セミコロンで終了するダイヤル文字列のことです。通常、通話は LINECALLSTATE_DIALING に遷移し、その後 lineDial を呼び出して、それぞれセミコロンで終了する追加のダイヤル文字列を指定できます。セミコロンで終了しないダイヤル文字列 (空文字列など) を指定して lineDial を呼び出すと、ダイヤルが完了します。この手法により、アプリケーションはユーザーと対話しながら部分ダイヤルを行ったり、TSP が対応できる範囲を超えた高度なダイヤルを実現したりできます。

lineMakeCall に null の宛先文字列、またはセミコロン (";") で終了する空文字列を指定した場合、アプリケーションは LINE_CALLSTATE_DIALTONE に遷移します。この状態で lineDial 関数を呼び出して、単一のダイヤル文字列、またはセミコロンで区切られた複数の部分ダイヤル文字列を入力できます。最初の桁が入力されると、アプリケーションは LINECALLSTATE_DIALING 状態に遷移します。

注 lineDial 関数は、通話が LINECALLSTATE_DIALING または LINE_CALLSTATE_DIALTONE の状態にある場合にのみ使用できます。通話が接続されている間 (LINECALLSTATE_CONNECTED) に DTMF が必要な場合は、lineGenerateDigits を使用してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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 lineDial(
    DWORD hCall,
    LPCSTR lpszDestAddress,
    DWORD dwCountryCode
);
[DllImport("TAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int lineDial(
    uint hCall,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string lpszDestAddress,   // LPCSTR
    uint dwCountryCode   // DWORD
);
<DllImport("TAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function lineDial(
    hCall As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpszDestAddress As String,   ' LPCSTR
    dwCountryCode As UInteger   ' DWORD
) As Integer
End Function
' hCall : DWORD
' lpszDestAddress : LPCSTR
' dwCountryCode : DWORD
Declare PtrSafe Function lineDial Lib "tapi32" ( _
    ByVal hCall As Long, _
    ByVal lpszDestAddress As String, _
    ByVal dwCountryCode As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

lineDial = ctypes.windll.tapi32.lineDial
lineDial.restype = ctypes.c_int
lineDial.argtypes = [
    wintypes.DWORD,  # hCall : DWORD
    wintypes.LPCSTR,  # lpszDestAddress : LPCSTR
    wintypes.DWORD,  # dwCountryCode : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('TAPI32.dll')
lineDial = Fiddle::Function.new(
  lib['lineDial'],
  [
    -Fiddle::TYPE_INT,  # hCall : DWORD
    Fiddle::TYPE_VOIDP,  # lpszDestAddress : LPCSTR
    -Fiddle::TYPE_INT,  # dwCountryCode : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "tapi32")]
extern "system" {
    fn lineDial(
        hCall: u32,  // DWORD
        lpszDestAddress: *const u8,  // LPCSTR
        dwCountryCode: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("TAPI32.dll", CharSet = CharSet.Ansi)]
public static extern int lineDial(uint hCall, [MarshalAs(UnmanagedType.LPStr)] string lpszDestAddress, uint dwCountryCode);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TAPI32_lineDial' -Namespace Win32 -PassThru
# $api::lineDial(hCall, lpszDestAddress, dwCountryCode)
#uselib "TAPI32.dll"
#func global lineDial "lineDial" sptr, sptr, sptr
; lineDial hCall, lpszDestAddress, dwCountryCode   ; 戻り値は stat
; hCall : DWORD -> "sptr"
; lpszDestAddress : LPCSTR -> "sptr"
; dwCountryCode : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "TAPI32.dll"
#cfunc global lineDial "lineDial" int, str, int
; res = lineDial(hCall, lpszDestAddress, dwCountryCode)
; hCall : DWORD -> "int"
; lpszDestAddress : LPCSTR -> "str"
; dwCountryCode : DWORD -> "int"
; INT lineDial(DWORD hCall, LPCSTR lpszDestAddress, DWORD dwCountryCode)
#uselib "TAPI32.dll"
#cfunc global lineDial "lineDial" int, str, int
; res = lineDial(hCall, lpszDestAddress, dwCountryCode)
; hCall : DWORD -> "int"
; lpszDestAddress : LPCSTR -> "str"
; dwCountryCode : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	tapi32 = windows.NewLazySystemDLL("TAPI32.dll")
	proclineDial = tapi32.NewProc("lineDial")
)

// hCall (DWORD), lpszDestAddress (LPCSTR), dwCountryCode (DWORD)
r1, _, err := proclineDial.Call(
	uintptr(hCall),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpszDestAddress))),
	uintptr(dwCountryCode),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function lineDial(
  hCall: DWORD;   // DWORD
  lpszDestAddress: PAnsiChar;   // LPCSTR
  dwCountryCode: DWORD   // DWORD
): Integer; stdcall;
  external 'TAPI32.dll' name 'lineDial';
result := DllCall("TAPI32\lineDial"
    , "UInt", hCall   ; DWORD
    , "AStr", lpszDestAddress   ; LPCSTR
    , "UInt", dwCountryCode   ; DWORD
    , "Int")   ; return: INT
●lineDial(hCall, lpszDestAddress, dwCountryCode) = DLL("TAPI32.dll", "int lineDial(dword, char*, dword)")
# 呼び出し: lineDial(hCall, lpszDestAddress, dwCountryCode)
# hCall : DWORD -> "dword"
# lpszDestAddress : LPCSTR -> "char*"
# dwCountryCode : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "tapi32" fn lineDial(
    hCall: u32, // DWORD
    lpszDestAddress: [*c]const u8, // LPCSTR
    dwCountryCode: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc lineDial(
    hCall: uint32,  # DWORD
    lpszDestAddress: cstring,  # LPCSTR
    dwCountryCode: uint32  # DWORD
): int32 {.importc: "lineDial", stdcall, dynlib: "TAPI32.dll".}
pragma(lib, "tapi32");
extern(Windows)
int lineDial(
    uint hCall,   // DWORD
    const(char)* lpszDestAddress,   // LPCSTR
    uint dwCountryCode   // DWORD
);
ccall((:lineDial, "TAPI32.dll"), stdcall, Int32,
      (UInt32, Cstring, UInt32),
      hCall, lpszDestAddress, dwCountryCode)
# hCall : DWORD -> UInt32
# lpszDestAddress : LPCSTR -> Cstring
# dwCountryCode : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t lineDial(
    uint32_t hCall,
    const char* lpszDestAddress,
    uint32_t dwCountryCode);
]]
local tapi32 = ffi.load("tapi32")
-- tapi32.lineDial(hCall, lpszDestAddress, dwCountryCode)
-- hCall : DWORD
-- lpszDestAddress : LPCSTR
-- dwCountryCode : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('TAPI32.dll');
const lineDial = lib.func('__stdcall', 'lineDial', 'int32_t', ['uint32_t', 'str', 'uint32_t']);
// lineDial(hCall, lpszDestAddress, dwCountryCode)
// hCall : DWORD -> 'uint32_t'
// lpszDestAddress : LPCSTR -> 'str'
// dwCountryCode : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("TAPI32.dll", {
  lineDial: { parameters: ["u32", "buffer", "u32"], result: "i32" },
});
// lib.symbols.lineDial(hCall, lpszDestAddress, dwCountryCode)
// hCall : DWORD -> "u32"
// lpszDestAddress : LPCSTR -> "buffer"
// dwCountryCode : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t lineDial(
    uint32_t hCall,
    const char* lpszDestAddress,
    uint32_t dwCountryCode);
C, "TAPI32.dll");
// $ffi->lineDial(hCall, lpszDestAddress, dwCountryCode);
// hCall : DWORD
// lpszDestAddress : LPCSTR
// dwCountryCode : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Tapi32 extends StdCallLibrary {
    Tapi32 INSTANCE = Native.load("tapi32", Tapi32.class, W32APIOptions.ASCII_OPTIONS);
    int lineDial(
        int hCall,   // DWORD
        String lpszDestAddress,   // LPCSTR
        int dwCountryCode   // DWORD
    );
}
@[Link("tapi32")]
lib LibTAPI32
  fun lineDial = lineDial(
    hCall : UInt32,   # DWORD
    lpszDestAddress : UInt8*,   # LPCSTR
    dwCountryCode : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef lineDialNative = Int32 Function(Uint32, Pointer<Utf8>, Uint32);
typedef lineDialDart = int Function(int, Pointer<Utf8>, int);
final lineDial = DynamicLibrary.open('TAPI32.dll')
    .lookupFunction<lineDialNative, lineDialDart>('lineDial');
// hCall : DWORD -> Uint32
// lpszDestAddress : LPCSTR -> Pointer<Utf8>
// dwCountryCode : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function lineDial(
  hCall: DWORD;   // DWORD
  lpszDestAddress: PAnsiChar;   // LPCSTR
  dwCountryCode: DWORD   // DWORD
): Integer; stdcall;
  external 'TAPI32.dll' name 'lineDial';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "lineDial"
  c_lineDial :: Word32 -> CString -> Word32 -> IO Int32
-- hCall : DWORD -> Word32
-- lpszDestAddress : LPCSTR -> CString
-- dwCountryCode : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let linedial =
  foreign "lineDial"
    (uint32_t @-> string @-> uint32_t @-> returning int32_t)
(* hCall : DWORD -> uint32_t *)
(* lpszDestAddress : LPCSTR -> string *)
(* dwCountryCode : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library tapi32 (t "TAPI32.dll"))
(cffi:use-foreign-library tapi32)

(cffi:defcfun ("lineDial" line-dial :convention :stdcall) :int32
  (h-call :uint32)   ; DWORD
  (lpsz-dest-address :string)   ; LPCSTR
  (dw-country-code :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $lineDial = Win32::API::More->new('TAPI32',
    'int lineDial(DWORD hCall, LPCSTR lpszDestAddress, DWORD dwCountryCode)');
# my $ret = $lineDial->Call($hCall, $lpszDestAddress, $dwCountryCode);
# hCall : DWORD -> DWORD
# lpszDestAddress : LPCSTR -> LPCSTR
# dwCountryCode : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目