ITLegacyCallMediaControl2::GatherDigits メソッド (tapi3if.h)
GatherDigits メソッドは、指定された呼び出しで数字の収集を開始します。 アプリケーションは、収集する最大桁数を指定します。
構文
HRESULT GatherDigits(
[in] TAPI_DIGITMODE DigitMode,
[in] long lNumDigits,
[in] BSTR pTerminationDigits,
[in] long lFirstDigitTimeout,
[in] long lInterDigitTimeout
);
パラメーター
[in] DigitMode
監視する数字モード。 このパラメーターは、1 つ以上の LINEDIGITMODE 定数を指定します。
[in] lNumDigits
収集する桁数。
このパラメーターが 0 の場合、メソッドは、新しい桁収集の試行を開始せずに、進行中の桁収集を取り消します。 詳細については、「解説」を参照してください。
[in] pTerminationDigits
終了桁の BSTR 表現へのポインター。 文字列内のいずれかの終了数字が検出されると、その数字がバッファーに追加され、digit コレクションが終了し、 TE_GATHERDIGITS イベントがアプリケーションに送信されます。
[in] lFirstDigitTimeout
最初の数字が必要な時間の長さ (ミリ秒単位)。 この時間枠で最初の桁が受信されない場合、数字の収集は中止され、 TE_GATHERDIGITS イベントがアプリケーションに送信されます。 バッファーには NULL 文字のみが含まれています。これは、数字が受信されなかったことを示し、最初の桁タイムアウトによって桁収集が終了したことを示します。 指定できる最小タイムアウトと最大タイムアウトは、AC_GATHERDIGITSMINTIMEOUT機能とAC_GATHERDIGITSMAXTIMEOUT機能にあります。
[in] lInterDigitTimeout
連続する数字の間の最大時間 (ミリ秒単位)。 この時間枠で次の桁が受信されない場合、桁の収集は中止され、 TE_GATHERDIGITS イベントがアプリケーションに送信されます。 バッファーには、この時点まで収集された数字の後に NULL 文字のみが含まれています。これは、インターディジット タイムアウトによって桁収集が終了したことを示します。 指定できる最小タイムアウトと最大タイムアウトは、AC_GATHERDIGITSMINTIMEOUTおよびAC_GATHERDIGITSMAXTIMEOUT機能にあります。
戻り値
このメソッドは、これらの値のいずれかを返すことができます。
リターン コード | 説明 |
---|---|
|
メソッドが成功しました。 |
|
pTerminationDigits パラメーターが有効なポインターではありません。 |
|
gather digits バッファーを割り当てるのに十分なメモリがありません。 |
|
呼び出しは 接続 状態である必要があります。 |
注釈
GatherDigits メソッドは TAPI 2 の呼び出しに変換されます。xlineGatherDigits 関数。
1 つの呼び出しで未処理の GatherDigits 呼び出しは 1 つだけです。 GatherDigits をもう一度呼び出すと、TE_GATHERDIGITS イベントが発生する前に、2 番目の呼び出しで前の数字の収集が取り消されます。 キャンセルされた数字収集の試行では、これまでに収集された数字を 含むTE_GATHERDIGITS イベントが送信されます。
要件
要件 | 値 |
---|---|
対象プラットフォーム | Windows |
ヘッダー | tapi3if.h |
Library | Uuid.lib |
[DLL] | Tapi3.dll |