ScriptStringOut 関数 (usp10.h)

  • [アーティクル]

ScriptStringAnalyse の以前の呼び出しによって生成された文字列を表示し、必要に応じて強調表示を追加します。

構文

HRESULT ScriptStringOut(
  [in]           SCRIPT_STRING_ANALYSIS ssa,
  [in]           int                    iX,
  [in]           int                    iY,
  [in]           UINT                   uOptions,
  [in, optional] const RECT             *prc,
  [in]           int                    iMinSel,
  [in]           int                    iMaxSel,
  [in]           BOOL                   fDisabled
);

パラメーター

[in] ssa

文字列の SCRIPT_STRING_ANALYSIS 構造体。

[in] iX

文字列の配置に使用される参照ポイントの x 座標。

[in] iY

文字列の配置に使用される参照ポイントの y 座標。

[in] uOptions

アプリケーション定義の四角形の使用を指定するオプション。 このパラメーターは、0 または次のいずれかの値に設定できます。 値はバイナリ OR と組み合わせることができます。

値 意味
ETO_CLIPPED
 テキストを四角形にクリップします。
ETO_OPAQUE
 現在の背景色を使用して四角形を塗りつぶします。

[in, optional] prc

使用する四角形を定義する RECT 構造体へのポインター。 uOptions が ETO_OPAQUE に設定されていて、prc に NULL が指定されている場合、関数は成功し、S_OKを返します。 ただし、アプリケーションで uOptions を ETO_CLIPPING に設定し、prc に NULL を指定すると、関数は E_INVALIDARGを返します。 アプリケーションでは、このパラメーターを NULL に設定して、オプションが不要であることを示すことができます。

[in] iMinSel

文字列内の開始位置を指定する 0 から始まるインデックス。 選択しない場合、アプリケーションは iMinSel>= iMaxSel を設定する必要があります。

[in] iMaxSel

文字列内の終了位置を指定する 0 から始まるインデックス。

[in] fDisabled

オペレーティング システムが無効なテキストの強調表示を適用する場合は TRUE を選択したすべての文字の背後に背景色をCOLOR_HIGHLIGHTに設定します。 オペレーティング システムが有効なテキストの強調表示を適用する場合、アプリケーションは、背景色をCOLOR_HIGHLIGHTに設定し、テキストの色を選択した文字ごとにCOLOR_HIGHLIGHTTEXTに設定すると、このパラメーターを FALSE に設定できます。

戻り値

成功した場合はS_OKを返します。 関数が成功しない場合は、0 以外の HRESULT 値を返します。 アプリケーションは、 SUCCEEDED マクロと FAILED マクロを使用して戻り値をテストできません。

注釈

この関数を使用するには、アプリケーションで ScriptStringAnalyse の元の呼び出しでSSA_GLYPHSを指定する必要があります。

選択したテキストを正しくレンダリングできないため、ScriptStringOut を使用する場合、アプリケーションでは TA_UPDATECP で SetTextAlign を使用しないでください。 アプリケーションでこのフラグを使用する必要がある場合は、フラグの設定を解除し、必要に応じてリセットして問題を回避できます。

大事なWindows 8以降: Windows 7 で実行する機能を維持するには、Uniscribe を使用するモジュールで、ライブラリ リストで gdi32.lib の前に Usp10.lib を指定する必要があります。
 

要件

要件 値
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー usp10.h
Library Usp10.lib
[DLL] Usp10.dll

こちらもご覧ください

SCRIPT_STRING_ANALYSIS

ScriptStringAnalyse

Uniscribe

Uniscribe 関数