lineGatherDigitsA

関数

通話で入力されたダイヤル数字を収集する(ANSI版)。

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

シグネチャ

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

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

パラメーター

名前	型	方向	説明
hCall	DWORD	in	数字を収集する対象のコールのハンドル。アプリケーションはそのコールの所有者である必要があります。hCall のコール状態は任意の状態でかまいません。
dwDigitModes	DWORD	in	監視する数字モード。このパラメーターには、 LINEDIGITMODE_ 定数のうち 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_ 定数を参照してください。このポインターが NULL の場合、または空の文字列を指している場合、この関数は終端数字が指定されなかったものとして動作します。
dwFirstDigitTimeout	DWORD	in	最初の数字が受信されることを期待する時間 (ミリ秒単位)。この時間内に最初の数字が受信されない場合、数字の収集は中止され、 LINE_GATHERDIGITS メッセージがアプリケーションに送信されます。このときバッファーには NULL 文字のみが格納され、数字が 1 つも受信されず、最初の数字のタイムアウトによって数字の収集が終了したことを示します。このパラメーターの有効範囲、またはタイムアウトがサポートされないことは、コールの回線デバイス機能で指定されます。
dwInterDigitTimeout	DWORD	in	連続する数字の間隔の最大時間 (ミリ秒単位)。この時間内に数字が受信されない場合、数字の収集は中止され、LINE_GATHERDIGITS メッセージがアプリケーションに送信されます。このときバッファーには、その時点までに収集された数字と、それに続く NULL 文字のみが格納され、数字間のタイムアウトによって数字の収集が終了したことを示します。このパラメーターの有効範囲、またはタイムアウトがサポートされないことは、コールの回線デバイス機能で指定されます。

戻り値の型: INT

公式ドキュメント

lineGatherDigits 関数は、指定されたコールでのバッファーを用いた数字の収集を開始します。アプリケーションは、数字を格納するバッファーと、収集する数字の最大個数を指定します。(lineGatherDigitsA)

戻り値

要求が成功した場合は 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 メッセージを受け取ることがあります。これは通常のアプリケーションの動作としては一般的ではありませんが、アプリケーションはこれらのメッセージの数を数えることで、取り消しのメッセージを以前の要求と対応付けることができます。いずれの場合も、有効とみなすべきなのは最も新しい要求だけです。

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

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

会議通話での数字の収集は hConfCall にのみ適用され、個々の参加コールには適用されません。

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

メモ

tapi.h ヘッダーは lineGatherDigits を、UNICODE プリプロセッサー定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング中立のエイリアスを、エンコーディング中立ではないコードと混在させて使用すると、不一致が発生し、コンパイルエラーや実行時エラーの原因となる可能性があります。詳細については、「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 lineGatherDigitsA(
    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 lineGatherDigitsA(
    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 lineGatherDigitsA(
    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 lineGatherDigitsA 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

lineGatherDigitsA = ctypes.windll.tapi32.lineGatherDigitsA
lineGatherDigitsA.restype = ctypes.c_int
lineGatherDigitsA.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')
lineGatherDigitsA = Fiddle::Function.new(
  lib['lineGatherDigitsA'],
  [
    -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 lineGatherDigitsA(
        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 lineGatherDigitsA(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_lineGatherDigitsA' -Namespace Win32 -PassThru
# $api::lineGatherDigitsA(hCall, dwDigitModes, lpsDigits, dwNumDigits, lpszTerminationDigits, dwFirstDigitTimeout, dwInterDigitTimeout)

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