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

ITAddressCapabilities

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

公式ドキュメント

ITAddressCapabilities インターフェースは、アドレスの機能に関する情報を取得するために使用します。Address オブジェクト上にあり、アプリケーションは Address オブジェクトに対して QueryInterface を呼び出すことでアクセスできます。

メソッド 8

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

vtbl 7 HRESULT get_AddressCapability(ADDRESS_CAPABILITY AddressCap, INT* plCapability)

get_AddressCapability メソッドは、指定した ADDRESS_CAPABILITY に対応する機能の値を取得します。

AddressCapADDRESS_CAPABILITYin取得するアドレス機能を示す記述子です。
plCapabilityINT*outアドレス機能の値です。

戻り値

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

リターンコード 説明
S_OK
メソッドは成功しました。
E_INVALIDARG
AddressCap パラメーターが無効です。
E_POINTER
plCapability パラメーターが有効なポインターではありません。
E_OUTOFMEMORY
操作を実行するのに十分なメモリがありません。
vtbl 8 HRESULT get_AddressCapabilityString(ADDRESS_CAPABILITY_STRING AddressCapString, LPWSTR* ppCapabilityString)

get_AddressCapabilityString メソッドは、指定した ADDRESS_CAPABILITY_STRING に対応する機能文字列を取得します。

AddressCapStringADDRESS_CAPABILITY_STRINGin取得するアドレス機能文字列を示す記述子です。
ppCapabilityStringLPWSTR*outアドレス機能の BSTR 値へのポインターです。TSP が AddressCapString に対する値を提供しない場合は、NULL が返されることがあります。

戻り値

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

リターンコード 説明
S_OK
メソッドは成功しました。
E_INVALIDARG
AddressCapString パラメーターが無効です。
E_POINTER
ppCapabilityString パラメーターが有効なポインターではありません。
TAPI_E_NOTSUPPORTED
TAPI のバージョンが 3.0 以上ではありません。
E_OUTOFMEMORY
操作を実行するのに十分なメモリがありません。

解説(Remarks)

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

vtbl 9 HRESULT get_CallTreatments(VARIANT* pVariant)

get_CallTreatments メソッドは、コールトリートメント(通話処理)を取得します。このメソッドは、Visual Basic やスクリプト言語で記述されたものなど、オートメーションクライアントアプリケーション向けに提供されています。

pVariantVARIANT*outコールトリートメントの ITCollection を格納する VARIANT へのポインターです。

戻り値

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

意味
S_OK
メソッドは成功しました。
TAPI_E_INVALCALLSTATE

コール状態CS_IDLE でなければなりません。

E_NOTIMPL
メソッドは実装されていません。
E_OUTOFMEMORY
操作を実行するのに十分なメモリがありません。

解説(Remarks)

TAPI は、ITAddressCapabilities::get_CallTreatments が返す ITCallInfo インターフェースに対して AddRef メソッドを呼び出します。アプリケーションは、 ITCallInfo インターフェースに関連付けられたリソースを解放するために、そのインターフェースに対して Release を呼び出す必要があります。

vtbl 10 HRESULT EnumerateCallTreatments(IEnumBstr** ppEnumCallTreatment)

EnumerateCallTreatments メソッドは、コールトリートメントを取得します。このメソッドは、C/C++ および Java で記述されたアプリケーション向けに提供されています。

ppEnumCallTreatmentIEnumBstr**outコールトリートメントの列挙子へのポインターです。

戻り値

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

意味
S_OK
メソッドは成功しました。
E_NOTIMPL
メソッドは実装されていません。
E_OUTOFMEMORY
操作を実行するのに十分なメモリがありません。

解説(Remarks)

TAPI は、ITAddressCapabilities::EnumerateCallTreatments が返す IEnumBstr インターフェースに対して AddRef メソッドを呼び出します。アプリケーションは、 IEnumBstr インターフェースに関連付けられたリソースを解放するために、そのインターフェースに対して Release を呼び出す必要があります。

vtbl 11 HRESULT get_CompletionMessages(VARIANT* pVariant)

get_CompletionMessages は、完了メッセージを取得します。このメソッドは、Visual Basic やスクリプト言語で記述されたものなど、オートメーションクライアントアプリケーション向けに提供されています。

pVariantVARIANT*out完了メッセージを格納する VARIANT へのポインターです。

戻り値

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

リターンコード 説明
S_OK
メソッドは成功しました。
E_NOTIMPL
メソッドは実装されていません。
E_OUTOFMEMORY
操作を実行するのに十分なメモリがありません。
vtbl 12 HRESULT EnumerateCompletionMessages(IEnumBstr** ppEnumCompletionMessage)

EnumerateCompletionMessages メソッドは、完了メッセージを取得します。このメソッドは、C/C++ および Java で記述されたアプリケーション向けに提供されています。

ppEnumCompletionMessageIEnumBstr**out完了メッセージの列挙子へのポインターです。

戻り値

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

意味
S_OK
メソッドは成功しました。
E_NOTIMPL
メソッドは実装されていません。
E_OUTOFMEMORY
操作を実行するのに十分なメモリがありません。

解説(Remarks)

TAPI は、ITAddressCapabilities::EnumerateCompletionMessages が返す IEnumBstr インターフェースに対して AddRef メソッドを呼び出します。アプリケーションは、 IEnumBstr インターフェースに関連付けられたリソースを解放するために、そのインターフェースに対して Release を呼び出す必要があります。

vtbl 13 HRESULT get_DeviceClasses(VARIANT* pVariant)

get_DeviceClasses メソッドは、デバイスクラスを取得します。このメソッドは、Visual Basic やスクリプト言語で記述されたものなど、オートメーションクライアントアプリケーション向けに提供されています。

pVariantVARIANT*outデバイスクラス を格納する VARIANT へのポインターです。

戻り値

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

リターンコード 説明
S_OK
メソッドは成功しました。
E_NOTIMPL
メソッドは実装されていません。
E_OUTOFMEMORY
操作を実行するのに十分なメモリがありません。
vtbl 14 HRESULT EnumerateDeviceClasses(IEnumBstr** ppEnumDeviceClass)

EnumerateDeviceClasses メソッドは、デバイスクラスを取得します。このメソッドは、C/C++ および Java で記述されたアプリケーション向けに提供されています。

ppEnumDeviceClassIEnumBstr**outデバイスクラス の列挙子へのポインターです。

戻り値

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

意味
S_OK
メソッドは成功しました。
E_NOTIMPL
メソッドは実装されていません。
E_OUTOFMEMORY
操作を実行するのに十分なメモリがありません。

解説(Remarks)

TAPI は、ITAddressCapabilities::EnumerateDeviceClasses が返す IEnumBstr インターフェースに対して AddRef メソッドを呼び出します。アプリケーションは、 IEnumBstr インターフェースに関連付けられたリソースを解放するために、そのインターフェースに対して Release を呼び出す必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITAddressCapabilities "{8DF232F5-821B-11D1-BB5C-00C04FB6809F}"
#usecom global ITAddressCapabilities IID_ITAddressCapabilities "{}"
#comfunc global ITAddressCapabilities_get_AddressCapability        7 int,var
#comfunc global ITAddressCapabilities_get_AddressCapabilityString  8 int,var
#comfunc global ITAddressCapabilities_get_CallTreatments           9 var
#comfunc global ITAddressCapabilities_EnumerateCallTreatments      10 sptr
#comfunc global ITAddressCapabilities_get_CompletionMessages       11 var
#comfunc global ITAddressCapabilities_EnumerateCompletionMessages  12 sptr
#comfunc global ITAddressCapabilities_get_DeviceClasses            13 var
#comfunc global ITAddressCapabilities_EnumerateDeviceClasses       14 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。