ホーム › Devices.Tapi › ITQueue

ITQueue

COMIDispatch (デュアル)

📘 Microsoft Learn (日本語) · English

✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。

IID5afc3149-4bcc-11d1-bf80-00805fc147d3継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

ITQueue インターフェイス (tapi3cc.h) は、キューに関する情報を取得および設定します。

メソッド 12

vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。

vtbl 7 HRESULT put_MeasurementPeriod(INT lPeriod)

ITQueue::put_MeasurementPeriod メソッド (tapi3cc.h) は、スイッチおよび/または実装が情報を格納および計算する期間 (秒単位) を設定します。

lPeriod

INT

測定期間 (秒単位)。

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

戻りコード	説明
S_OK	メソッドは成功しました。
E_INVALIDARG	lPeriod の値が 0 です。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。
TAPI_E_TIMEOUT	TAPI 3 DLL がタイムアウトさせたため、操作は失敗しました。タイムアウト間隔は 2 分です。
LINEERR_	この TAPI 2.1 関数から返されるエラーコードについては、 lineSetQueueMeasurementPeriod を参照してください。

解説(Remarks)

ITQueue::put_MeasurementPeriod メソッドは、TAPI 2.1 の lineSetQueueMeasurementPeriod 関数の COM ラッパーです。

このメソッドは測定期間として負の値を受け付けますが、通常はこれにより統計が信頼できないものになります。

vtbl 8 HRESULT get_MeasurementPeriod(INT* plPeriod)

ITQueue::get_MeasurementPeriod メソッド (tapi3cc.h) は、スイッチおよび/または実装が情報を格納および計算する測定期間を取得します。

plPeriod

INT*

out

測定期間へのポインター。

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

戻りコード	説明
S_OK	メソッドは成功しました。
E_POINTER	plPeriod が有効なポインターではありません。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。
TAPI_E_TIMEOUT	TAPI 3 DLL がタイムアウトさせたため、操作は失敗しました。タイムアウト間隔は 2 分です。

vtbl 9 HRESULT get_TotalCallsQueued(INT* plCalls)

ITQueue::get_TotalCallsQueued メソッド (tapi3cc.h) は、現在の測定期間中にこのキューに着信した通話 (コール) の総数を取得します。

plCalls

INT*

out

着信通話 (コール) の総数へのポインター。

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

戻りコード	説明
S_OK	メソッドは成功しました。
E_POINTER	plCalls パラメーターが有効なポインターではありません。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。
TAPI_E_TIMEOUT	TAPI 3 DLL がタイムアウトさせたため、操作は失敗しました。タイムアウト間隔は 2 分です。

vtbl 10 HRESULT get_CurrentCallsQueued(INT* plCalls)

ITQueue::get_CurrentCallsQueued メソッド (tapi3cc.h) は、現在待機している着信通話 (コール) の数を取得します。

plCalls

INT*

out

キュー内の着信通話 (コール) の数へのポインター。

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

戻りコード	説明
S_OK	メソッドは成功しました。
E_POINTER	plCalls が有効なポインターではありません。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。

vtbl 11 HRESULT get_TotalCallsAbandoned(INT* plCalls)

ITQueue::get_TotalCallsAbandoned メソッド (tapi3cc.h) は、現在の測定期間中に放棄された通話 (コール) の数を取得します。

plCalls

INT*

out

放棄された通話 (コール) の数へのポインター。

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

戻りコード	説明
S_OK	メソッドは成功しました。
E_POINTER	plCalls が有効なポインターではありません。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。
TAPI_E_TIMEOUT	TAPI 3 DLL がタイムアウトさせたため、操作は失敗しました。タイムアウト間隔は 2 分です。

vtbl 12 HRESULT get_TotalCallsFlowedIn(INT* plCalls)

ITQueue::get_TotalCallsFlowedIn メソッド (tapi3cc.h) は、現在の測定期間中にこのキューに流入した通話 (コール) の総数を取得します。

plCalls

INT*

out

通話 (コール) の数へのポインター。

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

戻りコード	説明
S_OK	メソッドは成功しました。
E_POINTER	plCalls が有効なポインターではありません。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。
TAPI_E_TIMEOUT	TAPI 3 DLL がタイムアウトさせたため、操作は失敗しました。タイムアウト間隔は 2 分です。

vtbl 13 HRESULT get_TotalCallsFlowedOut(INT* plCalls)

ITQueue::get_TotalCallsFlowedOut メソッド (tapi3cc.h) は、現在の測定期間中にこのキューから流出した通話 (コール) の総数を取得します。

plCalls

INT*

out

通話 (コール) の数へのポインター。

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

戻りコード	説明
S_OK	メソッドは成功しました。
E_POINTER	plCalls が有効なポインターではありません。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。
TAPI_E_TIMEOUT	TAPI 3 DLL がタイムアウトさせたため、操作は失敗しました。タイムアウト間隔は 2 分です。

vtbl 14 HRESULT get_LongestEverWaitTime(INT* plWaitTime)

ITQueue::get_LongestEverWaitTime メソッド (tapi3cc.h) は、現在の測定期間中にいずれかの通話 (コール) がキューで待機した最長時間 (秒単位) を取得します。

plWaitTime

INT*

out

待機時間へのポインター。

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

戻りコード	説明
S_OK	メソッドは成功しました。
E_POINTER	plWaitTime が有効なポインターではありません。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。
TAPI_E_TIMEOUT	TAPI 3 DLL がタイムアウトさせたため、操作は失敗しました。タイムアウト間隔は 2 分です。

vtbl 15 HRESULT get_CurrentLongestWaitTime(INT* plWaitTime)

ITQueue::get_CurrentLongestWaitTime メソッド (tapi3cc.h) は、現在の測定期間中に、現在の通話 (コール) がキューで待機している最長時間を取得します。

plWaitTime

INT*

out

待機時間へのポインター。

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

戻りコード	説明
S_OK	メソッドは成功しました。
E_POINTER	plWaitTime が有効なポインターではありません。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。
TAPI_E_TIMEOUT	TAPI 3 DLL がタイムアウトさせたため、操作は失敗しました。タイムアウト間隔は 2 分です。

vtbl 16 HRESULT get_AverageWaitTime(INT* plWaitTime)

ITQueue::get_AverageWaitTime メソッド (tapi3cc.h) は、現在の測定期間中の通話 (コール) 1 件あたりのキュー内平均滞在時間 (秒単位) を取得します。

plWaitTime

INT*

out

平均待機時間へのポインター。

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

戻りコード	説明
S_OK	メソッドは成功しました。
E_POINTER	plWaitTime が有効なポインターではありません。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。
TAPI_E_TIMEOUT	TAPI 3 DLL がタイムアウトさせたため、操作は失敗しました。タイムアウト間隔は 2 分です。

vtbl 17 HRESULT get_FinalDisposition(INT* plCalls)

ITQueue::get_FinalDisposition メソッド (tapi3cc.h) は、現在の測定期間中にコールガイドの最下部に到達した通話 (コール) の総数を取得します。

plCalls

INT*

out

通話 (コール) の数へのポインター。

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

戻りコード	説明
S_OK	メソッドは成功しました。
E_POINTER	plCalls が有効なポインターではありません。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。
TAPI_E_TIMEOUT	TAPI 3 DLL がタイムアウトさせたため、操作は失敗しました。タイムアウト間隔は 2 分です。

解説(Remarks)

この情報の測定期間は、スイッチおよび/または実装に固有です ( get_MeasurementPeriod を参照してください)。

vtbl 18 HRESULT get_Name(LPWSTR* ppName)

ITQueue::get_Name メソッド (tapi3cc.h) は、キュー名を取得します。

ppName

LPWSTR*

out

キュー名の BSTR 表現へのポインター。

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

戻りコード	説明
S_OK	メソッドは成功しました。
E_POINTER	ppName が有効なポインターではありません。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。

解説(Remarks)

アプリケーションは、ppName パラメーターに割り当てられたメモリを解放するために SysFreeString を使用する必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数:

#define global IID_ITQueue "{5AFC3149-4BCC-11D1-BF80-00805FC147D3}"
#usecom global ITQueue IID_ITQueue "{}"
#comfunc global ITQueue_put_MeasurementPeriod       7 int
#comfunc global ITQueue_get_MeasurementPeriod       8 var
#comfunc global ITQueue_get_TotalCallsQueued        9 var
#comfunc global ITQueue_get_CurrentCallsQueued      10 var
#comfunc global ITQueue_get_TotalCallsAbandoned     11 var
#comfunc global ITQueue_get_TotalCallsFlowedIn      12 var
#comfunc global ITQueue_get_TotalCallsFlowedOut     13 var
#comfunc global ITQueue_get_LongestEverWaitTime     14 var
#comfunc global ITQueue_get_CurrentLongestWaitTime  15 var
#comfunc global ITQueue_get_AverageWaitTime         16 var
#comfunc global ITQueue_get_FinalDisposition        17 var
#comfunc global ITQueue_get_Name                    18 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_ITQueue "{5AFC3149-4BCC-11D1-BF80-00805FC147D3}"
#usecom global ITQueue IID_ITQueue "{}"
#comfunc global ITQueue_put_MeasurementPeriod       7 int
#comfunc global ITQueue_get_MeasurementPeriod       8 sptr
#comfunc global ITQueue_get_TotalCallsQueued        9 sptr
#comfunc global ITQueue_get_CurrentCallsQueued      10 sptr
#comfunc global ITQueue_get_TotalCallsAbandoned     11 sptr
#comfunc global ITQueue_get_TotalCallsFlowedIn      12 sptr
#comfunc global ITQueue_get_TotalCallsFlowedOut     13 sptr
#comfunc global ITQueue_get_LongestEverWaitTime     14 sptr
#comfunc global ITQueue_get_CurrentLongestWaitTime  15 sptr
#comfunc global ITQueue_get_AverageWaitTime         16 sptr
#comfunc global ITQueue_get_FinalDisposition        17 sptr
#comfunc global ITQueue_get_Name                    18 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。