lineGenerateDigits

関数

通話上に指定したダイヤル数字を生成して送出する。

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

シグネチャ

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

INT lineGenerateDigits(
    DWORD hCall,
    DWORD dwDigitMode,
    LPCSTR lpszDigits,
    DWORD dwDuration
);

パラメーター

名前	型	方向	説明
hCall	DWORD	in	通話のハンドル。アプリケーションはその通話の所有者である必要があります。hCall の通話状態は任意の状態でかまいません。TAPI は通話状態に関する要件を課しませんが、一部の TAPI サービスプロバイダーでは hCall が LINECALLSTATE_CONNECTED 状態であることを要求する場合があります。
dwDigitMode	DWORD	in	これらの桁のシグナリングに使用する形式。dwDigitMode には 1 つのフラグしか設定できないことに注意してください。このパラメーターには LINEDIGITMODE_ 定数のいずれかを使用します。
lpszDigits	LPCSTR	in	生成する桁を格納した null 終端の文字バッファーへのポインター。有効な文字は、dwDigitModes に指定した LINEDIGITMODE_ 定数に対して規定されている文字です。さらに、コンマ (,) も有効な文字です。コンマは、それが区切る前の桁と次の桁のシグナリングの間に追加の遅延を挿入します。この一時停止の長さは構成によって定義され、回線デバイスの機能がこの長さを示します。複数のコンマを使用すると、より長い一時停止を挿入できます。無効な桁はエラーとして報告されるのではなく、生成時に無視されます。感嘆符 (!) も有効な文字です。この文字は、ダイヤル可能なアドレスで説明されている "hookflash" 操作を発生させます。
dwDuration	DWORD	in	DTMF の桁の継続時間 (ミリ秒単位) と、パルスおよび DTMF の桁間隔の両方を指定します。値 0 を指定すると既定値が使用されます。dwDuration パラメーターは、 LINEDEVCAPS の MinDialParams および MaxDialParams で指定される範囲内である必要があります。範囲外の場合、実際の値は範囲内で最も近い値に設定されます。

戻り値の型: INT

公式ドキュメント

lineGenerateDigits 関数 (tapi.h) は、指定されたシグナリングモードを使用して、指定された桁を指定された通話上でインバンドトーンとして生成する処理を開始します。

戻り値

要求が成功した場合は 0 を、エラーが発生した場合は負のエラー番号を返します。返される可能性のある値は次のとおりです。

LINEERR_INVALCALLHANDLE、LINEERR_NOTOWNER、LINEERR_INVALCALLSTATE、LINEERR_OPERATIONUNAVAIL、LINEERR_INVALDIGITMODE、LINEERR_OPERATIONFAILED、LINEERR_INVALPOINTER、LINEERR_RESOURCEUNAVAIL、LINEERR_NOMEM、LINEERR_UNINITIALIZED。

解説(Remarks)

lineGenerateDigits 関数は、すべての桁が生成された時点ではなく、桁の生成が正常に開始された時点で正常に完了したと見なされます。ネットワークに依存する方法で桁をダイヤルする lineDial とは対照的に、 lineGenerateDigits は、DTMF を使用して、またはパルスを使用する場合はフックスイッチのダイヤルパルスを使用して、音声チャネル上にインバンドトーンとして桁を生成することを保証します。 lineGenerateDigits 関数は、一般に発信やダイヤルには適していません。この関数は、確立済みの通話上でのエンドツーエンドのシグナリングを目的としています。

lpszDigits 内のすべての桁が生成された後、または桁の生成が中止あるいは取り消された後、 LINE_GENERATE メッセージがアプリケーションに送信されます。

1 つの通話につき、その通話の所有者であるすべてのアプリケーションを通じて、同時に実行できるインバンド生成要求 (トーン生成または桁生成) は 1 つだけです。通話上の桁の生成は、別の桁生成要求またはトーン生成要求を開始することで取り消されます。現在の桁の生成を取り消すには、アプリケーションは lineGenerateDigits を呼び出し、lpszDigits パラメーターに NULL を指定します。

サービスプロバイダーとハードウェアによっては、アプリケーションが自身で生成した桁を監視できます。それが望ましくない場合、アプリケーションは桁の生成中に桁の監視を無効にできます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 lineGenerateDigits(
    DWORD hCall,
    DWORD dwDigitMode,
    LPCSTR lpszDigits,
    DWORD dwDuration
);

[DllImport("TAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int lineGenerateDigits(
    uint hCall,   // DWORD
    uint dwDigitMode,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string lpszDigits,   // LPCSTR
    uint dwDuration   // DWORD
);

<DllImport("TAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function lineGenerateDigits(
    hCall As UInteger,   ' DWORD
    dwDigitMode As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpszDigits As String,   ' LPCSTR
    dwDuration As UInteger   ' DWORD
) As Integer
End Function

' hCall : DWORD
' dwDigitMode : DWORD
' lpszDigits : LPCSTR
' dwDuration : DWORD
Declare PtrSafe Function lineGenerateDigits Lib "tapi32" ( _
    ByVal hCall As Long, _
    ByVal dwDigitMode As Long, _
    ByVal lpszDigits As String, _
    ByVal dwDuration As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

lineGenerateDigits = ctypes.windll.tapi32.lineGenerateDigits
lineGenerateDigits.restype = ctypes.c_int
lineGenerateDigits.argtypes = [
    wintypes.DWORD,  # hCall : DWORD
    wintypes.DWORD,  # dwDigitMode : DWORD
    wintypes.LPCSTR,  # lpszDigits : LPCSTR
    wintypes.DWORD,  # dwDuration : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('TAPI32.dll')
lineGenerateDigits = Fiddle::Function.new(
  lib['lineGenerateDigits'],
  [
    -Fiddle::TYPE_INT,  # hCall : DWORD
    -Fiddle::TYPE_INT,  # dwDigitMode : DWORD
    Fiddle::TYPE_VOIDP,  # lpszDigits : LPCSTR
    -Fiddle::TYPE_INT,  # dwDuration : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "tapi32")]
extern "system" {
    fn lineGenerateDigits(
        hCall: u32,  // DWORD
        dwDigitMode: u32,  // DWORD
        lpszDigits: *const u8,  // LPCSTR
        dwDuration: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("TAPI32.dll", CharSet = CharSet.Ansi)]
public static extern int lineGenerateDigits(uint hCall, uint dwDigitMode, [MarshalAs(UnmanagedType.LPStr)] string lpszDigits, uint dwDuration);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TAPI32_lineGenerateDigits' -Namespace Win32 -PassThru
# $api::lineGenerateDigits(hCall, dwDigitMode, lpszDigits, dwDuration)

#uselib "TAPI32.dll"
#func global lineGenerateDigits "lineGenerateDigits" sptr, sptr, sptr, sptr
; lineGenerateDigits hCall, dwDigitMode, lpszDigits, dwDuration   ; 戻り値は stat
; hCall : DWORD -> "sptr"
; dwDigitMode : DWORD -> "sptr"
; lpszDigits : LPCSTR -> "sptr"
; dwDuration : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

#uselib "TAPI32.dll"
#cfunc global lineGenerateDigits "lineGenerateDigits" int, int, str, int
; res = lineGenerateDigits(hCall, dwDigitMode, lpszDigits, dwDuration)
; hCall : DWORD -> "int"
; dwDigitMode : DWORD -> "int"
; lpszDigits : LPCSTR -> "str"
; dwDuration : DWORD -> "int"

; INT lineGenerateDigits(DWORD hCall, DWORD dwDigitMode, LPCSTR lpszDigits, DWORD dwDuration)
#uselib "TAPI32.dll"
#cfunc global lineGenerateDigits "lineGenerateDigits" int, int, str, int
; res = lineGenerateDigits(hCall, dwDigitMode, lpszDigits, dwDuration)
; hCall : DWORD -> "int"
; dwDigitMode : DWORD -> "int"
; lpszDigits : LPCSTR -> "str"
; dwDuration : DWORD -> "int"

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	tapi32 = windows.NewLazySystemDLL("TAPI32.dll")
	proclineGenerateDigits = tapi32.NewProc("lineGenerateDigits")
)

// hCall (DWORD), dwDigitMode (DWORD), lpszDigits (LPCSTR), dwDuration (DWORD)
r1, _, err := proclineGenerateDigits.Call(
	uintptr(hCall),
	uintptr(dwDigitMode),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpszDigits))),
	uintptr(dwDuration),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT

function lineGenerateDigits(
  hCall: DWORD;   // DWORD
  dwDigitMode: DWORD;   // DWORD
  lpszDigits: PAnsiChar;   // LPCSTR
  dwDuration: DWORD   // DWORD
): Integer; stdcall;
  external 'TAPI32.dll' name 'lineGenerateDigits';

result := DllCall("TAPI32\lineGenerateDigits"
    , "UInt", hCall   ; DWORD
    , "UInt", dwDigitMode   ; DWORD
    , "AStr", lpszDigits   ; LPCSTR
    , "UInt", dwDuration   ; DWORD
    , "Int")   ; return: INT

●lineGenerateDigits(hCall, dwDigitMode, lpszDigits, dwDuration) = DLL("TAPI32.dll", "int lineGenerateDigits(dword, dword, char*, dword)")
# 呼び出し: lineGenerateDigits(hCall, dwDigitMode, lpszDigits, dwDuration)
# hCall : DWORD -> "dword"
# dwDigitMode : DWORD -> "dword"
# lpszDigits : LPCSTR -> "char*"
# dwDuration : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "tapi32" fn lineGenerateDigits(
    hCall: u32, // DWORD
    dwDigitMode: u32, // DWORD
    lpszDigits: [*c]const u8, // LPCSTR
    dwDuration: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;

proc lineGenerateDigits(
    hCall: uint32,  # DWORD
    dwDigitMode: uint32,  # DWORD
    lpszDigits: cstring,  # LPCSTR
    dwDuration: uint32  # DWORD
): int32 {.importc: "lineGenerateDigits", stdcall, dynlib: "TAPI32.dll".}

pragma(lib, "tapi32");
extern(Windows)
int lineGenerateDigits(
    uint hCall,   // DWORD
    uint dwDigitMode,   // DWORD
    const(char)* lpszDigits,   // LPCSTR
    uint dwDuration   // DWORD
);

ccall((:lineGenerateDigits, "TAPI32.dll"), stdcall, Int32,
      (UInt32, UInt32, Cstring, UInt32),
      hCall, dwDigitMode, lpszDigits, dwDuration)
# hCall : DWORD -> UInt32
# dwDigitMode : DWORD -> UInt32
# lpszDigits : LPCSTR -> Cstring
# dwDuration : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
int32_t lineGenerateDigits(
    uint32_t hCall,
    uint32_t dwDigitMode,
    const char* lpszDigits,
    uint32_t dwDuration);
]]
local tapi32 = ffi.load("tapi32")
-- tapi32.lineGenerateDigits(hCall, dwDigitMode, lpszDigits, dwDuration)
-- hCall : DWORD
-- dwDigitMode : DWORD
-- lpszDigits : LPCSTR
-- dwDuration : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('TAPI32.dll');
const lineGenerateDigits = lib.func('__stdcall', 'lineGenerateDigits', 'int32_t', ['uint32_t', 'uint32_t', 'str', 'uint32_t']);
// lineGenerateDigits(hCall, dwDigitMode, lpszDigits, dwDuration)
// hCall : DWORD -> 'uint32_t'
// dwDigitMode : DWORD -> 'uint32_t'
// lpszDigits : LPCSTR -> 'str'
// dwDuration : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("TAPI32.dll", {
  lineGenerateDigits: { parameters: ["u32", "u32", "buffer", "u32"], result: "i32" },
});
// lib.symbols.lineGenerateDigits(hCall, dwDigitMode, lpszDigits, dwDuration)
// hCall : DWORD -> "u32"
// dwDigitMode : DWORD -> "u32"
// lpszDigits : LPCSTR -> "buffer"
// dwDuration : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t lineGenerateDigits(
    uint32_t hCall,
    uint32_t dwDigitMode,
    const char* lpszDigits,
    uint32_t dwDuration);
C, "TAPI32.dll");
// $ffi->lineGenerateDigits(hCall, dwDigitMode, lpszDigits, dwDuration);
// hCall : DWORD
// dwDigitMode : DWORD
// lpszDigits : LPCSTR
// dwDuration : 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 lineGenerateDigits(
        int hCall,   // DWORD
        int dwDigitMode,   // DWORD
        String lpszDigits,   // LPCSTR
        int dwDuration   // DWORD
    );
}

@[Link("tapi32")]
lib LibTAPI32
  fun lineGenerateDigits = lineGenerateDigits(
    hCall : UInt32,   # DWORD
    dwDigitMode : UInt32,   # DWORD
    lpszDigits : UInt8*,   # LPCSTR
    dwDuration : 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 lineGenerateDigitsNative = Int32 Function(Uint32, Uint32, Pointer<Utf8>, Uint32);
typedef lineGenerateDigitsDart = int Function(int, int, Pointer<Utf8>, int);
final lineGenerateDigits = DynamicLibrary.open('TAPI32.dll')
    .lookupFunction<lineGenerateDigitsNative, lineGenerateDigitsDart>('lineGenerateDigits');
// hCall : DWORD -> Uint32
// dwDigitMode : DWORD -> Uint32
// lpszDigits : LPCSTR -> Pointer<Utf8>
// dwDuration : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function lineGenerateDigits(
  hCall: DWORD;   // DWORD
  dwDigitMode: DWORD;   // DWORD
  lpszDigits: PAnsiChar;   // LPCSTR
  dwDuration: DWORD   // DWORD
): Integer; stdcall;
  external 'TAPI32.dll' name 'lineGenerateDigits';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "lineGenerateDigits"
  c_lineGenerateDigits :: Word32 -> Word32 -> CString -> Word32 -> IO Int32
-- hCall : DWORD -> Word32
-- dwDigitMode : DWORD -> Word32
-- lpszDigits : LPCSTR -> CString
-- dwDuration : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let linegeneratedigits =
  foreign "lineGenerateDigits"
    (uint32_t @-> uint32_t @-> string @-> uint32_t @-> returning int32_t)
(* hCall : DWORD -> uint32_t *)
(* dwDigitMode : DWORD -> uint32_t *)
(* lpszDigits : LPCSTR -> string *)
(* dwDuration : 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 ("lineGenerateDigits" line-generate-digits :convention :stdcall) :int32
  (h-call :uint32)   ; DWORD
  (dw-digit-mode :uint32)   ; DWORD
  (lpsz-digits :string)   ; LPCSTR
  (dw-duration :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $lineGenerateDigits = Win32::API::More->new('TAPI32',
    'int lineGenerateDigits(DWORD hCall, DWORD dwDigitMode, LPCSTR lpszDigits, DWORD dwDuration)');
# my $ret = $lineGenerateDigits->Call($hCall, $dwDigitMode, $lpszDigits, $dwDuration);
# hCall : DWORD -> DWORD
# dwDigitMode : DWORD -> DWORD
# lpszDigits : LPCSTR -> LPCSTR
# dwDuration : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。