lineGenerateDigits 関数 (tapi.h)

[アーティクル]
08/26/2023

lineGenerateDigits 関数は、指定されたシグナリングモードを使用して、指定された呼び出しで指定された数字の生成をインバンドトーンとして開始します。 lpszDigits の NULL 値を指定してこの関数を呼び出すと、現在進行中の数字の生成が中止されます。数字の生成が進行中に lineGenerateDigits または lineGenerateTone を呼び出すと、現在のディジット生成またはトーン生成が中止され、最後に指定された数字またはトーンの生成が開始されます。

構文

LONG lineGenerateDigits(
  HCALL  hCall,
  DWORD  dwDigitMode,
  LPCSTR lpszDigits,
  DWORD  dwDuration
);

パラメーター

hCall

呼び出しを処理します。アプリケーションは、呼び出しの所有者である必要があります。 hCall の呼び出し状態は任意の状態にすることができます。 TAPI では呼び出し状態の要件は課されませんが、一部の Tapi サービスプロバイダーでは hCall がLINECALLSTATE_CONNECTED状態であることが必要になる場合があります。

dwDigitMode

これらの数字のシグナリングに使用する形式。 dwDigitMode には 1 つのフラグしか設定できないことに注意してください。このパラメーターでは、 LINEDIGITMODE_定数のいずれかを使用します。

lpszDigits

生成される数字を含む null で終わる文字バッファーへのポインター。有効な文字は、dwDigitModes で提供されるLINEDIGITMODE_定数に指定された文字です。

さらに、コンマ (,) も有効な文字です。コンマは、区切られた前の数字と次の桁のシグナリングの間に余分な遅延を挿入します。この一時停止の期間は構成が定義されており、回線デバイスの機能はこの期間を示します。複数のコンマを使用して、より長い一時停止を挿入できます。無効な数字は、エラーとして報告されるのではなく、生成中に無視されます。

感嘆符 (!) は有効な文字です。この文字は、ダイヤル可能アドレスに関する説明に従って、"hookflash" 操作を引き起こします。

dwDuration

DTMF 桁とパルスと DTMF 桁間間隔の両方の時間 (ミリ秒単位)。値 0 は既定値を使用します。 dwDuration パラメーターは、LINEDEVCAPS の MinDialParams および MaxDialParams で指定された範囲内である必要があります。範囲外の場合、実際の値は範囲内で最も近い値に設定されます。

戻り値

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

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

注釈

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

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

呼び出しの所有者であるすべてのアプリケーションで、呼び出しごとに進行中のインバンド生成要求 (トーン生成またはディジット生成) は 1 つだけです。呼び出しのディジット生成は、別のディジット生成要求またはトーン生成要求を開始することによって取り消されます。現在の桁の生成を取り消すために、アプリケーションは lineGenerateDigits を呼び出し、lpszDigits パラメーターに NULL を指定できます。

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