TSPI_lineGenerateDigits関数 (tspi.h)

  • [アーティクル]

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

メモ 呼び出しごとに進行中のインバンド生成要求 (トーン生成またはディジット生成) は一度に 1 つだけです。
 

構文

LONG TSPIAPI TSPI_lineGenerateDigits(
  HDRVCALL hdCall,
  DWORD    dwEndToEndID,
  DWORD    dwDigitMode,
  LPCWSTR  lpszDigits,
  DWORD    dwDuration
);

パラメーター

hdCall

ディジット生成を実行する呼び出しへのハンドル。

dwEndToEndID

この一意の要求識別子は、サービス プロバイダーによって格納され、桁の生成が完了したときに dwParam2 として LINEEVENT プロシージャに渡される必要があります。

dwDigitMode

これらの数字のシグナリングに使用する形式。 このパラメーターは、 LINEDIGITMODE_定数の 1 つだけを使用します。

lpszDigits

生成される数字を含む null で終わる Unicode 文字バッファーへのポインター。 コンマは、区切られた前の数字と次の桁のシグナリングの間に余分な遅延を挿入します。 この一時停止の期間は構成定義です。 回線のデバイス機能は、この期間が何であるかを示します。 複数のコンマを使用して、より長い一時停止を挿入できます。 無効な数字は、エラーとして報告されるのではなく、生成中に無視されます。

dwDuration

DTMF ディジットとパルスと DTMF ディジット間の間隔の両方をミリ秒単位で指定します。 値 0 は既定値を使用します。 dwDuration パラメーターは、MINDialParams から LINEDEVCAPS の MaxDialParams に指定された範囲内である必要があります。 範囲外の場合、実際の値は、サービス プロバイダーによって範囲内の最も近い値に設定されます。 このパラメーターは、この関数が呼び出されたときに TAPI によって検証されません。

戻り値

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

LINEERR_INVALCALLHANDLE、LINEERR_NOMEM、LINEERR_INVALCALLSTATE、LINEERR_OPERATIONUNAVAIL、LINEERR_INVALDIGITMODE、LINEERR_OPERATIONFAILED、LINEERR_RESOURCEUNAVAIL、LINEERR_RESOURCEUNAVAIL。

解説

hdCall の呼び出し状態は、任意の状態にすることができます。

TSPI_lineGenerateDigits関数は、ディジット生成が正常に開始されると正常に完了したと見なされます。すべての数字が生成される場合ではありません。

lpsDigits のすべての数字が生成された後、または桁の生成が中止または取り消された後に、LINE_GENERATEメッセージが TAPI に送信されます。

メモ 1 回の呼び出しで進行中のインバンド生成要求 (トーン生成またはディジット生成) は 1 つだけです。 これは、通話で現在ディジット生成が進行中の場合、 TSPI_lineGenerateDigits または TSPI_lineGenerateTone を呼び出すと、ディジット生成が取り消されることを意味します。 サービス プロバイダーは、後続の TSPI_lineGenerateDigits または TSPI_lineGenerateTone が呼び出されたときに、進行中の桁生成を終了する必要があります。 lpszDigits を NULL に設定してTSPI_lineGenerateDigitsを呼び出すと、現在の数字 (またはトーン) の生成が取り消されます。
 
TAPI レベルの対応する関数には、仮パラメーター dwEndToEndID は含まれません。 そのレベルでは、エンド ツー エンドのマーキングはありません。 TAPI では、TSPI レベルでエンド ツー エンドのマーキングを使用して、ある TSPI_lineGenerateDigits 要求を別の要求から明確にします。

要件

   
対象プラットフォーム Windows
ヘッダー tspi.h

関連項目

LINEDEVCAPS

LINEDIGITMODE_定数

LINEEVENT

LINE_GENERATE

TSPI_lineGenerateTone