Метод ITextPara::GetTab (tom.h)

Статья
03/02/2024

Извлекает параметры вкладки (смещение, выравнивание и стиль лидера) для указанной вкладки.

Синтаксис

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

Параметры

iTab

Тип: long

Индекс вкладки, для которой требуется получить сведения. Это может быть либо числовой индекс, либо специальное значение (см. таблицу ниже). Так как индексы табуляции основаны на нулях, iTab = нуль получает определение первой вкладки, iTab = 1 получает вторую определенную вкладку и т. д. В следующей таблице перечислены все возможные значения iTab.

iTab	Значение	Значение
tomTabBack	–3	Переход на вкладку до * ptbPos
tomTabNext	–2	Получение следующей вкладки * ptbPos
tomTabHere	–1	Получить вкладку в * ptbPos
	>= 0	Получение вкладки с индексом iTab (и пропуск ptbPos).

ptbPos

Тип: float*

Смещение табуляции в точках с плавающей запятой. Значение * ptbPos равно нулю, если вкладка не существует, а значение * ptbPos равно tomUndefined, если в связанном диапазоне есть несколько значений.

ptbAlign

Тип: long*

Выравнивание табуляции. Дополнительные сведения см. в разделе ITextPara::AddTab.

ptbLeader

Тип: long*

Стиль символа-лидера вкладки. Дополнительные сведения см. в разделе ITextPara::AddTab.

Возвращаемое значение

Тип: HRESULT

Если ITextPara::GetTab завершается успешно, он возвращает S_OK. Если метод завершается сбоем, он возвращает один из следующих кодов com-ошибок. Дополнительные сведения о кодах ошибок COM см. в разделе Обработка ошибок в COM.

Код возврата	Описание
Значение	Значение
E_INVALIDARG	Недопустимый аргумент.
CO_E_RELEASED	Объект форматирования абзаца присоединяется к удаленному диапазону.
S_FALSE	Вкладка, соответствующая iTab, отсутствует.

Требования

Требование	Значение
Минимальная версия клиента	Windows Vista [только классические приложения]
Минимальная версия сервера	Windows Server 2003 [только классические приложения]
Целевая платформа	Windows
Header	tom.h
DLL	Msftedit.dll