Win32 API 日本語リファレンス
ホームUI.TextServices › ITfSpeechUIServer

ITfSpeechUIServer

COM
IID90e9a944-9244-489f-a78f-de67afc013a7継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ITfSpeechUIServer インターフェイスは、TSF 言語バー上の音声関連のユーザーインターフェイスを管理します。

解説(Remarks)

このインターフェイスが管理する TSF 言語バー上のユーザーインターフェイス要素には、マイクボタン、音声構成メニューボタン、ディクテーションボタン、コマンドボタン、および音声バルーンが含まれます。通常、標準の音声テキストサービスが、初期化を含めてアプリケーション内のこれらのユーザーインターフェイス要素を管理します。この種のアプリケーションでは ITfSpeechUIServer インターフェイスは必要ありません。

音声テキストサービスを使用しないアプリケーションでも、音声関連のインターフェイス要素が提供する機能を利用する必要がある場合があります。その場合、次のコード例に示すように、アプリケーションは CLSID_SpeechUIServer CLSID を指定して CoCreateInstance 関数を呼び出すことで、ITfSpeechUIServer インターフェイスへのポインターを取得できます。


HRESULT hr;
ITfSpeechUIServer* piSpeechUIServer;

hr = CoCreateInstance(CLSID_SpeechUIServer,
                      NULL,
                      CLSCTX_INPROC_SERVER,
                      IID_ITfSpeechUIServer,
                      (void**)&piSpeechUIServer);

その後、アプリケーションは ITfSpeechUIServer::Initialize メソッドでユーザーインターフェイスを初期化し、ITfSpeechUIServer インターフェイスの他のメソッドを使用してユーザーインターフェイスを管理できます。

メソッド 3

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT Initialize()

ITfSpeechUIServer::Initialize メソッド

戻り値

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

説明
S_OK
メソッドは成功しました。

解説(Remarks)

通常、標準の音声テキストサービスが TSF 言語バー上の音声関連のユーザーインターフェイスを初期化します。音声テキストサービスを使用しない TSF 対応アプリケーションが ITfSpeechUIServer インターフェイスを使用する必要がある場合は、このメソッドでユーザーインターフェイスを初期化します。

vtbl 4 HRESULT ShowUI(BOOL fShow)

ITfSpeechUIServer::ShowUI メソッド

fShowBOOLin音声関連のユーザーインターフェイス要素を表示する (TRUE) か、表示しない (FALSE) かを指定します。

戻り値

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

説明
S_OK
メソッドは成功しました。
vtbl 5 HRESULT UpdateBalloon(TfLBBalloonStyle style, LPWSTR pch, DWORD cch)

ITfSpeechUIServer::UpdateBalloon メソッド

styleTfLBBalloonStyleinバルーンのスタイルを指定する TfLBBalloonStyle の要素を格納します。
pchLPWSTRinバルーンに表示するテキストを格納する、ゼロ終端の Unicode 文字列へのポインターです。
cchDWORDinpch パラメーターの文字列に含まれる文字数を指定します。

戻り値

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

説明
S_OK
メソッドは成功しました。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITfSpeechUIServer "{90E9A944-9244-489F-A78F-DE67AFC013A7}"
#usecom global ITfSpeechUIServer IID_ITfSpeechUIServer "{}"
#comfunc global ITfSpeechUIServer_Initialize     3
#comfunc global ITfSpeechUIServer_ShowUI         4 int
#comfunc global ITfSpeechUIServer_UpdateBalloon  5 int,wstr,int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。