Win32 API 日本語リファレンス
ホームDevices.Tapi › ITForwardInformation

ITForwardInformation

COMIDispatch (デュアル)
IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IID449f659e-88a3-11d1-bb5d-00c04fb6809f継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

ITForwardInformation インターフェイスは、通話の転送を設定および実装するためのメソッドを提供します。

メソッド 7

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

vtbl 7 HRESULT put_NumRingsNoAnswer(INT lNumRings)

put_NumRingsNoAnswer メソッドは、応答なしの状態と見なすまでの呼び出し音の回数を設定します。

lNumRingsINTin呼び出し音の回数。

戻り値

このメソッドは次のいずれかの値を返します。

戻り値 説明
S_OK
メソッドは成功しました。
E_OUTOFMEMORY
操作を実行するのに十分なメモリがありません。
vtbl 8 HRESULT get_NumRingsNoAnswer(INT* plNumRings)

get_NumRingsNoAnswer メソッドは、応答なしの状態と見なすまでの呼び出し音の回数を取得します。

plNumRingsINT*out呼び出し音の回数へのポインター。

戻り値

このメソッドは次のいずれかの値を返します。

戻り値 説明
S_OK
メソッドは成功しました。
E_OUTOFMEMORY
操作を実行するのに十分なメモリがありません。
E_POINTER
plNumRings パラメーターが有効なポインターではありません。
vtbl 9 HRESULT SetForwardType(INT ForwardType, LPWSTR pDestAddress, LPWSTR pCallerAddress)

SetForwardType メソッドは、発信者アドレスによって転送モードと転送先を設定します。

ForwardTypeINTin回線転送モード
pDestAddressLPWSTRin転送先アドレスの BSTR 表現へのポインター。
pCallerAddressLPWSTRin発信者アドレスの BSTR 表現へのポインター。

戻り値

このメソッドは次のいずれかの値を返します。

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

解説(Remarks)

アプリケーションは、pDestAddress および pCallerAddress パラメーターのメモリを割り当てるために SysAllocString を使用する必要があります。変数が不要になったら、アプリケーションは SysFreeString を使用してメモリを解放する必要があります。

vtbl 10 HRESULT get_ForwardTypeDestination(INT ForwardType, LPWSTR* ppDestAddress)

get_ForwardTypeDestination メソッドは、転送モードに対する転送先を取得します。

ForwardTypeINTin回線転送モード
ppDestAddressLPWSTR*out転送先アドレスの BSTR 表現へのポインター。

戻り値

このメソッドは次のいずれかの値を返します。

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

解説(Remarks)

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

vtbl 11 HRESULT get_ForwardTypeCaller(INT Forwardtype, LPWSTR* ppCallerAddress)

get_ForwardTypeCaller メソッドは、指定した転送モードに対する発信者の種類を取得します。

ForwardtypeINTin回線転送モード
ppCallerAddressLPWSTR*out発信者アドレスの BSTR 表現へのポインター。

戻り値

このメソッドは次のいずれかの値を返します。

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

解説(Remarks)

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

vtbl 12 HRESULT GetForwardType(INT ForwardType, LPWSTR* ppDestinationAddress, LPWSTR* ppCallerAddress)

GetForwardType メソッドは、転送モードを取得します。

ForwardTypeINTin回線転送モード
ppDestinationAddressLPWSTR*out転送先アドレスの BSTR 表現へのポインター。
ppCallerAddressLPWSTR*out通話の発信元アドレスの BSTR 表現へのポインター。

戻り値

このメソッドは次のいずれかの値を返します。

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

解説(Remarks)

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

vtbl 13 HRESULT Clear()

Clear メソッドは、このオブジェクト内のすべての転送情報をクリアします。

戻り値

このメソッドは次のいずれかの値を返します。

戻り値 説明
S_OK
メソッドは成功しました。
E_OUTOFMEMORY
操作を実行するのに十分なメモリがありません。

解説(Remarks)

このメソッドは、サービスプロバイダー内の転送情報はクリアしません。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITForwardInformation "{449F659E-88A3-11D1-BB5D-00C04FB6809F}"
#usecom global ITForwardInformation IID_ITForwardInformation "{}"
#comfunc global ITForwardInformation_put_NumRingsNoAnswer        7 int
#comfunc global ITForwardInformation_get_NumRingsNoAnswer        8 var
#comfunc global ITForwardInformation_SetForwardType              9 int,wstr,wstr
#comfunc global ITForwardInformation_get_ForwardTypeDestination  10 int,var
#comfunc global ITForwardInformation_get_ForwardTypeCaller       11 int,var
#comfunc global ITForwardInformation_GetForwardType              12 int,var,var
#comfunc global ITForwardInformation_Clear                       13
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。