GetTextAlign 関数 (wingdi.h)

GetTextAlign 関数は、指定されたデバイスコンテキストのテキスト配置設定を取得します。

構文

UINT GetTextAlign(
  [in] HDC hdc
);

[in] hdc

デバイスコンテキストへのハンドル。

関数が成功した場合、戻り値はテキスト配置フラグの状態になります。戻り値の詳細については、「解説」セクションを参照してください。戻り値は、次の値の組み合わせです。

値	意味
TA_BASELINE	参照ポイントは、テキストの基準線上にあります。
TA_BOTTOM	参照ポイントは、外接する四角形の下端にあります。
TA_TOP	参照ポイントは、外接する四角形の上端にあります。
TA_CENTER	基準点は、外接する四角形の中心に水平方向に配置されます。
TA_LEFT	参照ポイントは、外接する四角形の左端にあります。
TA_RIGHT	参照ポイントは、外接する四角形の右端にあります。
TA_RTLREADING	Windows の中東言語エディション: テキストは、既定の左から右の順序ではなく、右から左の読み取り順序でレイアウトされます。これは、デバイスコンテキストで選択されたフォントがヘブライ語またはアラビア語である場合にのみ適用されます。
TA_NOUPDATECP	現在の位置は、各テキスト出力呼び出しの後に更新されません。
TA_UPDATECP	現在の位置は、各テキスト出力呼び出しの後に更新されます。

現在のフォントに (漢字と同様に) 垂直の既定の基本行がある場合は、TA_BASELINEとTA_CENTERの代わりに次の値が使用されます。

値	意味
VTA_BASELINE	参照ポイントは、テキストの基準線上にあります。
VTA_CENTER	基準点は、外接する四角形の中心に垂直に配置されます。

関数が失敗した場合、戻り値はGDI_ERROR。

外接する四角形は、文字列内のすべての文字セルを囲む四角形です。そのディメンションは、 GetTextExtentPoint32 関数を呼び出すことによって取得できます。

text-alignment フラグは、TextOut 関数と ExtTextOut 関数が、TextOut または ExtTextOut に提供される文字列の参照ポイントに関連して文字列を配置する方法を決定します。

テキストアラインメントフラグは必ずしも単一ビットフラグではなく、0 に等しい場合があります。フラグは、次の一覧に示すように、関連するフラグのグループで調べる必要があります。

現在のフォントに垂直の既定の基本行がある場合、関連するフラグは次の一覧に示すように表示されます。

この関数の戻り値に特定のフラグが設定されていることを確認するには、

例については、「テキストの配置の設定」を参照してください。

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