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

ITLocationInfo

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

公式ドキュメント

ITLocationInfo インターフェイスは、発信者の所在地(ロケーション)に関連する情報を取得するために使用します。これは、コントロール パネルのテレフォニー アプレットを使用して入力される所在地情報です。

メソッド 11

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

vtbl 7 HRESULT get_PermanentLocationID(INT* plLocationID)

get_PermanentLocationID メソッドは、永続的な所在地識別子を取得します。

plLocationIDINT*out永続的な所在地識別子へのポインター。

戻り値

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

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

解説(Remarks)

このメソッドが返す値は、TAPI 2 の LINELOCATIONENTRY 構造体の dwPermanentLocationID メンバーに対応します。

vtbl 8 HRESULT get_CountryCode(INT* plCountryCode)

get_CountryCode メソッドは、国/地域コードを取得します。

plCountryCodeINT*out国/地域コードへのポインター。

戻り値

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

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

解説(Remarks)

このメソッドが返す値は、TAPI 2 の LINELOCATIONENTRY 構造体の dwCountryCode メンバーに対応します。

vtbl 9 HRESULT get_CountryID(INT* plCountryID)

get_CountryID メソッドは、国/地域の識別子を取得します。

plCountryIDINT*out国/地域の ID。

戻り値

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

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

解説(Remarks)

このメソッドが返す値は、TAPI 2 の LINELOCATIONENTRY 構造体の dwCountryID メンバーに対応します。

vtbl 10 HRESULT get_Options(INT* plOptions)

get_Options メソッドは、現在の所在地がパルス ダイヤルとトーン ダイヤルのどちらをサポートしているかを示す値を取得します。

plOptionsINT*outダイヤル オプション。 LINELOCATIONOPTION_ 定数の値で示されます。

戻り値

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

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

解説(Remarks)

このメソッドが返す値は、TAPI 2 の LINELOCATIONENTRY 構造体の dwOptions メンバーに対応します。

vtbl 11 HRESULT get_PreferredCardID(INT* plCardID)

get_PreferredCardID メソッドは、現在の所在地からダイヤルする際に優先的に使用するテレホン カードの識別子を取得します。

plCardIDINT*outテレホン カードの ID。

戻り値

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

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

解説(Remarks)

このメソッドが返す値は、TAPI 2 の LINELOCATIONENTRY 構造体の dwPreferredCardID メンバーに対応します。

vtbl 12 HRESULT get_LocationName(LPWSTR* ppLocationName)

get_LocationName メソッドは、所在地名を取得します。

ppLocationNameLPWSTR*out所在地名の BSTR 表現へのポインター。

戻り値

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

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

解説(Remarks)

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

このメソッドが返す値は、TAPI 2 の LINELOCATIONENTRY 構造体の dwLocationNameSize メンバーと dwLocationNameOffset メンバーに対応します。

vtbl 13 HRESULT get_CityCode(LPWSTR* ppCode)

get_CityCode メソッドは、市外局番(市のコード)を取得します。

ppCodeLPWSTR*out市外局番の BSTR 表現へのポインター。

戻り値

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

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

解説(Remarks)

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

このメソッドが返す値は、TAPI 2 の LINELOCATIONENTRY 構造体の dwCityCodeSize メンバーと dwCityCodeOffset メンバーに対応します。

vtbl 14 HRESULT get_LocalAccessCode(LPWSTR* ppCode)

get_LocalAccessCode メソッドは、市内発信用のアクセス コードを取得します。

ppCodeLPWSTR*out市内発信用アクセス コードの BSTR 表現へのポインター。

戻り値

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

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

解説(Remarks)

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

このメソッドが返す値は、TAPI 2 の LINELOCATIONENTRY 構造体の dwLocalAccessCodeSize メンバーと dwLocalAccessCodeOffset メンバーに対応します。

vtbl 15 HRESULT get_LongDistanceAccessCode(LPWSTR* ppCode)

get_LongDistanceAccessCode メソッドは、長距離電話にアクセスするためのコードを取得します。

ppCodeLPWSTR*out長距離電話アクセス コードの BSTR 表現へのポインター。

戻り値

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

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

解説(Remarks)

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

このメソッドが返す値は、TAPI 2 の LINELOCATIONENTRY 構造体の dwLongDistanceAccessCodeSize メンバーと dwLongDistanceAccessCodeOffset メンバーに対応します。

vtbl 16 HRESULT get_TollPrefixList(LPWSTR* ppTollList)

get_TollPrefixList メソッドは、市外料金プレフィックスの一覧を取得します。

ppTollListLPWSTR*out市外料金プレフィックスの一覧を含む BSTR へのポインター。

戻り値

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

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

解説(Remarks)

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

このメソッドが返す値は、TAPI 2 の LINELOCATIONENTRY 構造体の dwTollPrefixListSize メンバーと dwTollPrefixListOffset メンバーに対応します。

vtbl 17 HRESULT get_CancelCallWaitingCode(LPWSTR* ppCode)

get_CancelCallWaitingCode メソッドは、キャッチホン(割り込み通話)を取り消すためにダイヤル文字列の先頭に付加する必要があるダイヤル数字と修飾文字を取得します。

ppCodeLPWSTR*outキャッチホン(割り込み通話)を取り消すために必要なダイヤル数字と修飾文字の BSTR 表現へのポインター。

戻り値

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

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

解説(Remarks)

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

このメソッドが返す値は、TAPI 2 の LINELOCATIONENTRY 構造体の dwCancelCallWaitingSize メンバーと dwCancelCallWaitingOffset メンバーに対応します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITLocationInfo "{0C4D8EFF-8DDB-11D1-A09E-00805FC147D3}"
#usecom global ITLocationInfo IID_ITLocationInfo "{}"
#comfunc global ITLocationInfo_get_PermanentLocationID     7 var
#comfunc global ITLocationInfo_get_CountryCode             8 var
#comfunc global ITLocationInfo_get_CountryID               9 var
#comfunc global ITLocationInfo_get_Options                 10 var
#comfunc global ITLocationInfo_get_PreferredCardID         11 var
#comfunc global ITLocationInfo_get_LocationName            12 var
#comfunc global ITLocationInfo_get_CityCode                13 var
#comfunc global ITLocationInfo_get_LocalAccessCode         14 var
#comfunc global ITLocationInfo_get_LongDistanceAccessCode  15 var
#comfunc global ITLocationInfo_get_TollPrefixList          16 var
#comfunc global ITLocationInfo_get_CancelCallWaitingCode   17 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。