DrawTextWrap 関数
[DrawTextWrap は、Windows XP と Service Pack 2 (SP2) を使用して使用できます。 後続のバージョンでは変更または使用できない可能性があります。 代わりに DrawText を直接使用することをお勧めします。
指定した四角形に書式設定されたテキストを描画します。 指定したメソッド (タブの展開、文字の正当化、改行など) に従ってテキストの書式を設定します。 この関数は DrawText の呼び出しをラップします。
構文
int WINAPI DrawTextWrap(
_In_ HDC hdc,
_Inout_ LPCTSTR lpString,
_In_ int nCount,
_Inout_ LPRECT lpRect,
_In_ UINT uFormat,
_In_ LPDRAWTEXTPARAMS lpDTParams
);
パラメーター
-
hdc [in]
-
種類: HDC
デバイス コンテキストへのハンドル。
-
lpString [in, out]
-
型: LPCTSTR
描画するテキストを含むバッファーへのポインター。 nCount パラメーターが -1 の場合、文字列は null で終わる必要があります。
uFormat にDT_MODIFYSTRINGが含まれている場合、関数はこの文字列に最大 4 文字を追加できます。 文字列を含むバッファーは、これらの余分な文字に対応できる十分な大きさにする必要があります。
-
nCount [in]
-
型: int
lpString が指す文字列の長さ。 nCount が -1 の場合、lpString パラメーターは null で終わる文字列へのポインターであると見なされ、DrawText によって文字数が自動的に計算されます。
-
lpRect [in, out]
-
型: LPRECT
テキストを書式設定する四角形を論理座標で含む RECT 構造体へのポインター。
-
uFormat [in]
-
型: UINT
書式設定オプション。 オプションの完全な一覧については、 DrawText のドキュメントを参照してください。
-
lpDTParams [in]
-
型: LPDRAWTEXTPARAMS
追加の書式設定オプションを指定する DRAWTEXTPARAMS 構造体へのポインター。 このパラメーターは、NULL でもかまいません。
戻り値
型: int
関数が成功した場合、戻り値は論理単位のテキストの高さになります。 DT_VCENTERまたはDT_BOTTOMを指定した場合、戻り値は lprc の最上位メンバーから描画されたテキストの下部までのオフセットです。関数が失敗した場合、戻り値は 0 になります。
関数が失敗した場合は、0 を返します。
詳細なエラー情報を得るには、GetLastError を呼び出します。
注釈
DrawTextWrap は、名前によってエクスポートされたり、パブリック ヘッダーで宣言されたりしません。 これを使用するには、 GetProcAddress を 使用し、ComCtl32.dllから序数 415 を要求して関数ポインターを取得する必要があります。
その他の解説については、「 DrawText」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント |
Windows Vista [デスクトップ アプリのみ] |
| サポートされている最小のサーバー |
Windows Server 2003 [デスクトップ アプリのみ] |
| [DLL] |
|