Método ITextPara::GetTab (tom.h)

Artigo
03/13/2024

Recupera parâmetros de guia (deslocamento, alinhamento e estilo de líder) para uma guia especificada.

Sintaxe

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

Parâmetros

iTab

Tipo: long

Índice da guia para a qual recuperar informações. Pode ser um índice numérico ou um valor especial (consulte a tabela a seguir). Como os índices de guia são baseados em zero, iTab = zero obtém a primeira guia definida, iTab = 1 obtém a segunda guia definida e assim por diante. A tabela a seguir resume todos os valores possíveis de iTab.

iTab	Valor	Significado
tomTabBack	–3	Obter guia anterior a * ptbPos
tomTabNext	–2	Obter guia a seguir * ptbPos
tomTabHere	–1	Guia Obter em * ptbPos
	>= 0	Guia Obter com o índice de iTab (e ignorar ptbPos).

ptbPos

Tipo: float*

O deslocamento de tabulação, em pontos de ponto flutuante. O valor de * ptbPos será zero se a guia não existir e o valor de * ptbPos for tomUndefined se houver vários valores no intervalo associado.

ptbAlign

Tipo: long*

O alinhamento da guia. Para obter mais informações, consulte ITextPara::AddTab.

ptbLeader

Tipo: long*

O estilo de caractere de líder da guia. Para obter mais informações, consulte ITextPara::AddTab.

Retornar valor

Tipo: HRESULT

Se ITextPara::GetTab for bem-sucedido, ele retornará S_OK. Se o método falhar, ele retornará um dos seguintes códigos de erro COM. Para obter mais informações sobre códigos de erro COM, consulte Tratamento de erros em COM.

Código de retorno	Descrição
Valor	Significado
E_INVALIDARG	Argumento inválido.
CO_E_RELEASED	O objeto de formatação de parágrafo é anexado a um intervalo que foi excluído.
S_FALSE	Não há nenhuma guia correspondente a iTab.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	tom.h
DLL	Msftedit.dll