lineGatherDigits

関数

通話で入力されたダイヤル数字をバッファに収集する。

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

シグネチャ

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

INT lineGatherDigits(
    DWORD hCall,
    DWORD dwDigitModes,
    LPSTR lpsDigits,   // optional
    DWORD dwNumDigits,
    LPCSTR lpszTerminationDigits,
    DWORD dwFirstDigitTimeout,
    DWORD dwInterDigitTimeout
);

パラメーター

名前	型	方向	説明
hCall	DWORD	in	桁を収集する対象の通話のハンドル。アプリケーションはその通話の所有者である必要があります。hCall の通話状態は、どの状態であってもかまいません。
dwDigitModes	DWORD	in	監視する桁モード。このパラメーターには、 LINEDIGITMODE_ Constants のうち 1 つ以上を使用します。
lpsDigits	LPSTR	outoptional	検出された桁をテキスト文字として格納するバッファーへのポインター。桁は、収集されるたびに 1 つずつバッファーに現れるとは限りません。 LINE_GATHERDIGITS メッセージを受信した後にのみ、バッファーの内容が有効であるとみなしてください。lpsDigits が NULL の場合、その通話で現在進行中の桁の収集は終了し、dwNumDigits は無視されます。それ以外の場合、lpsDigits には dwNumDigits 個の桁を格納できる領域があるものとみなされます。
dwNumDigits	DWORD	in	LINE_GATHERDIGITS メッセージがアプリケーションに送信されるまでに収集する桁数。lpsDigits が NULL の場合、dwNumDigits パラメーターは無視されます。dwNumDigits が 0 の場合、この関数は失敗します。
lpszTerminationDigits	LPCSTR	in	終端桁をテキスト文字で表した Null 終端文字列。この文字列に含まれる桁のいずれかが検出されると、その終端桁がバッファーに追加され、桁の収集が終了して、 LINE_GATHERDIGITS メッセージがアプリケーションに送信されます。有効な文字の一覧は、dwDigitModes に指定した定数によって異なります。各モードで有効な文字の一覧については、 LINEDIGITMODE_ Constants を参照してください。このポインターが NULL の場合、または空の文字列を指している場合、この関数は終端桁が指定されなかったものとして動作します。
dwFirstDigitTimeout	DWORD	in	最初の桁が受信されるまでに想定される時間 (ミリ秒単位)。この時間内に最初の桁が受信されない場合、桁の収集は中止され、 LINE_GATHERDIGITS メッセージがアプリケーションに送信されます。バッファーには NULL 文字のみが格納され、桁が 1 つも受信されず、最初の桁のタイムアウトによって桁の収集が終了したことを示します。このパラメーターの有効範囲、またはタイムアウトがサポートされていないことは、その通話の回線デバイス機能 (line-device capabilities) で示されます。
dwInterDigitTimeout	DWORD	in	連続する桁の間隔の最大時間 (ミリ秒単位)。この時間内に桁が受信されない場合、桁の収集は中止され、LINE_GATHERDIGITS メッセージがアプリケーションに送信されます。バッファーには、その時点までに収集された桁とそれに続く NULL 文字のみが格納され、桁間のタイムアウトによって桁の収集が終了したことを示します。このパラメーターの有効範囲、またはタイムアウトがサポートされていないことは、その通話の回線デバイス機能 (line-device capabilities) で示されます。

戻り値の型: INT

公式ドキュメント

lineGatherDigits 関数 (tapi.h) は、指定された通話でのバッファーを使用したダイヤル桁の収集を開始します。

戻り値

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

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

解説(Remarks)

桁の収集は、要求された数の桁が収集された時点で終了します。また、指定された数の桁が収集される前に、検出された桁のいずれかが szTerminationDigits 内の桁と一致した場合にも終了します。検出された終端桁もバッファーに格納され、途中までのバッファーが返されます。

桁の収集が取り消されるもう 1 つのケースは、いずれかのタイムアウトが経過した場合です。dwFirstDigitTimeout は、この時間内に最初の桁が受信されない場合に経過します。dwInterDigitTimout は、直前に検出された桁から数えてその時間内に 2 桁目、3 桁目 (以降も同様) が受信されない場合に経過し、途中までのバッファーが返されます。

桁の収集を終了させる 4 つ目の方法は、収集の進行中にこの関数を再度呼び出すことです。この場合、以前の収集セッションは終了し、その時点までに収集された桁は前回この関数を呼び出したときに指定されたバッファーにコピーされ、 LINE_GATHERDIGITS メッセージがアプリケーションに送信されるときにそのバッファーが渡されます。新たな桁の収集を開始せずに桁の収集だけを終了させるには、lpsDigits に NULL を指定してこの関数を呼び出します。

この関数は、桁の収集が正しく開始された場合に成功とみなされます。桁の収集が終了したかどうかは関係ありません。途中までのバッファーが返されるすべての場合において、有効な桁 (存在する場合) の後には NULL 文字が続きます。

この関数はどの通話状態でも呼び出せますが、通常、桁を収集できるのは通話が connected 状態の間だけです。

LINE_GATHERDIGITS メッセージは、要求を開始したアプリケーションにのみ送信されます。このメッセージは、タイムアウトや終端桁の一致によって途中までのバッファーが返される場合、およびその通話に対する別の lineGatherDigits 要求によって要求が取り消される場合にも送信されます。桁収集の要求は、その通話の所有者であるすべてのアプリケーションを通じて、1 つの通話に対して同時に 1 つしかアクティブにできません。この操作は非同期であるため、アプリケーションが lineGatherDigits 要求を短い間隔で複数発行することは可能であり、その場合は後から複数の LINE_GATHERDIGITS メッセージを受け取ることになります。これは通常のアプリケーションの動作としては一般的ではありませんが、アプリケーションはこれらのメッセージの数を数えることで、取り消しのメッセージを以前の要求と対応付けることができます。いずれの場合も、有効とみなすべきなのは最新の要求だけです。

Note アプリケーションのメモリにデータを書き戻す非同期操作をアプリケーションが呼び出す場合、アプリケーションは LINE_REPLY メッセージまたは LINE_GATHERDIGITS メッセージを受信するまで、そのメモリに書き込み可能な状態を維持する必要があります。

アプリケーションは lineMonitorDigits を使用して、バッファーを使用しない桁の検出を有効または無効にできます。この方法で桁が検出されるたびに、 LINE_MONITORDIGITS メッセージがアプリケーションに送信されます。同じ通話に対して、バッファーを使用する桁の検出と使用しない桁の検出を同時に有効にできます。

会議通話での桁の収集は hConfCall にのみ適用され、個々の参加中の通話には適用されません。

lineGatherDigits 関数を使用して以前の桁収集要求を取り消した場合、この関数はその時点までに収集された桁を、元の関数呼び出しで指定されたバッファーにコピーします。その後、2 回目の呼び出しの lpszDigits パラメーターに NULL や別のアドレスが指定されているかどうかにかかわらず、LINE_GATHERDIGITS メッセージをアプリケーションに送信します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 lineGatherDigits(
    DWORD hCall,
    DWORD dwDigitModes,
    LPSTR lpsDigits,   // optional
    DWORD dwNumDigits,
    LPCSTR lpszTerminationDigits,
    DWORD dwFirstDigitTimeout,
    DWORD dwInterDigitTimeout
);

[DllImport("TAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int lineGatherDigits(
    uint hCall,   // DWORD
    uint dwDigitModes,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpsDigits,   // LPSTR optional, out
    uint dwNumDigits,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string lpszTerminationDigits,   // LPCSTR
    uint dwFirstDigitTimeout,   // DWORD
    uint dwInterDigitTimeout   // DWORD
);

<DllImport("TAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function lineGatherDigits(
    hCall As UInteger,   ' DWORD
    dwDigitModes As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpsDigits As System.Text.StringBuilder,   ' LPSTR optional, out
    dwNumDigits As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpszTerminationDigits As String,   ' LPCSTR
    dwFirstDigitTimeout As UInteger,   ' DWORD
    dwInterDigitTimeout As UInteger   ' DWORD
) As Integer
End Function

' hCall : DWORD
' dwDigitModes : DWORD
' lpsDigits : LPSTR optional, out
' dwNumDigits : DWORD
' lpszTerminationDigits : LPCSTR
' dwFirstDigitTimeout : DWORD
' dwInterDigitTimeout : DWORD
Declare PtrSafe Function lineGatherDigits Lib "tapi32" ( _
    ByVal hCall As Long, _
    ByVal dwDigitModes As Long, _
    ByVal lpsDigits As String, _
    ByVal dwNumDigits As Long, _
    ByVal lpszTerminationDigits As String, _
    ByVal dwFirstDigitTimeout As Long, _
    ByVal dwInterDigitTimeout As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

lineGatherDigits = ctypes.windll.tapi32.lineGatherDigits
lineGatherDigits.restype = ctypes.c_int
lineGatherDigits.argtypes = [
    wintypes.DWORD,  # hCall : DWORD
    wintypes.DWORD,  # dwDigitModes : DWORD
    wintypes.LPSTR,  # lpsDigits : LPSTR optional, out
    wintypes.DWORD,  # dwNumDigits : DWORD
    wintypes.LPCSTR,  # lpszTerminationDigits : LPCSTR
    wintypes.DWORD,  # dwFirstDigitTimeout : DWORD
    wintypes.DWORD,  # dwInterDigitTimeout : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('TAPI32.dll')
lineGatherDigits = Fiddle::Function.new(
  lib['lineGatherDigits'],
  [
    -Fiddle::TYPE_INT,  # hCall : DWORD
    -Fiddle::TYPE_INT,  # dwDigitModes : DWORD
    Fiddle::TYPE_VOIDP,  # lpsDigits : LPSTR optional, out
    -Fiddle::TYPE_INT,  # dwNumDigits : DWORD
    Fiddle::TYPE_VOIDP,  # lpszTerminationDigits : LPCSTR
    -Fiddle::TYPE_INT,  # dwFirstDigitTimeout : DWORD
    -Fiddle::TYPE_INT,  # dwInterDigitTimeout : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "tapi32")]
extern "system" {
    fn lineGatherDigits(
        hCall: u32,  // DWORD
        dwDigitModes: u32,  // DWORD
        lpsDigits: *mut u8,  // LPSTR optional, out
        dwNumDigits: u32,  // DWORD
        lpszTerminationDigits: *const u8,  // LPCSTR
        dwFirstDigitTimeout: u32,  // DWORD
        dwInterDigitTimeout: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("TAPI32.dll", CharSet = CharSet.Ansi)]
public static extern int lineGatherDigits(uint hCall, uint dwDigitModes, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpsDigits, uint dwNumDigits, [MarshalAs(UnmanagedType.LPStr)] string lpszTerminationDigits, uint dwFirstDigitTimeout, uint dwInterDigitTimeout);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TAPI32_lineGatherDigits' -Namespace Win32 -PassThru
# $api::lineGatherDigits(hCall, dwDigitModes, lpsDigits, dwNumDigits, lpszTerminationDigits, dwFirstDigitTimeout, dwInterDigitTimeout)

#uselib "TAPI32.dll"
#func global lineGatherDigits "lineGatherDigits" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; lineGatherDigits hCall, dwDigitModes, varptr(lpsDigits), dwNumDigits, lpszTerminationDigits, dwFirstDigitTimeout, dwInterDigitTimeout   ; 戻り値は stat
; hCall : DWORD -> "sptr"
; dwDigitModes : DWORD -> "sptr"
; lpsDigits : LPSTR optional, out -> "sptr"
; dwNumDigits : DWORD -> "sptr"
; lpszTerminationDigits : LPCSTR -> "sptr"
; dwFirstDigitTimeout : DWORD -> "sptr"
; dwInterDigitTimeout : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "TAPI32.dll"
#cfunc global lineGatherDigits "lineGatherDigits" int, int, var, int, str, int, int
; res = lineGatherDigits(hCall, dwDigitModes, lpsDigits, dwNumDigits, lpszTerminationDigits, dwFirstDigitTimeout, dwInterDigitTimeout)
; hCall : DWORD -> "int"
; dwDigitModes : DWORD -> "int"
; lpsDigits : LPSTR optional, out -> "var"
; dwNumDigits : DWORD -> "int"
; lpszTerminationDigits : LPCSTR -> "str"
; dwFirstDigitTimeout : DWORD -> "int"
; dwInterDigitTimeout : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "TAPI32.dll"
#cfunc global lineGatherDigits "lineGatherDigits" int, int, sptr, int, str, int, int
; res = lineGatherDigits(hCall, dwDigitModes, varptr(lpsDigits), dwNumDigits, lpszTerminationDigits, dwFirstDigitTimeout, dwInterDigitTimeout)
; hCall : DWORD -> "int"
; dwDigitModes : DWORD -> "int"
; lpsDigits : LPSTR optional, out -> "sptr"
; dwNumDigits : DWORD -> "int"
; lpszTerminationDigits : LPCSTR -> "str"
; dwFirstDigitTimeout : DWORD -> "int"
; dwInterDigitTimeout : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。