ITextPara::GetTab メソッド (tom.h)

[アーティクル]
03/05/2024

指定したタブのタブパラメーター (ディスプレイスメント、配置、およびリーダースタイル) を取得します。

構文

HRESULT GetTab(
  long  iTab,
  float *ptbPos,
  long  *ptbAlign,
  long  *ptbLeader
);

パラメーター

iTab

型: long

情報を取得するタブのインデックス。数値インデックスまたは特殊な値を指定できます (次の表を参照)。タブインデックスは 0 から始まるため、 iTab = 0 は最初に定義されたタブを取得し、 iTab = 1 は 2 番目に定義されたタブを取得します。次の表は、 iTab の使用可能なすべての値をまとめたものです。

Itab	値	意味
tomTabBack	–3	* ptbPos より前のタブを取得する
tomTabNext	–2	* ptbPos に続くタブを取得する
tomTabHere	–1	* ptbPos でタブを取得する
	>= 0	iTab のインデックスを含むタブを取得します (ptbPos は無視します)。

ptbPos

型: float*

タブの変位 (浮動小数点)。タブが存在せず、関連付けられた範囲内に複数の値がある場合、 * ptbPos の値が tomUndefined の場合、 * ptbPos の値は 0 になります。

ptbAlign

型: long*

タブの配置。詳細については、「 ITextPara::AddTab」を参照してください。

ptbLeader

型: long*

タブリーダー文字スタイル。詳細については、「 ITextPara::AddTab」を参照してください。

戻り値

型: HRESULT

ITextPara::GetTab が成功すると、S_OKが返されます。メソッドが失敗した場合は、次のいずれかの COM エラーコードを返します。 COM エラーコードの詳細については、「COM でのエラー処理」を参照してください。

リターンコード	説明
Value	意味
E_INVALIDARG	引数が無効です。
CO_E_RELEASED	段落書式オブジェクトは、削除された範囲にアタッチされます。
S_FALSE	iTab に対応するタブはありません。

要件

要件	値
サポートされている最小のクライアント	Windows Vista [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows Server 2003 (デスクトップアプリのみ)
対象プラットフォーム	Windows
ヘッダー	tom.h
[DLL]	Msftedit.dll