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

Article
03/04/2024

Récupère les paramètres d’onglet (déplacement, alignement et style de leader) pour un onglet spécifié.

Syntaxe

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

Paramètres

iTab

Type : long

Index de l’onglet pour lequel récupérer les informations. Il peut s’agir d’un index numérique ou d’une valeur spéciale (voir le tableau suivant). Étant donné que les index de tabulation sont de base zéro, iTab = zéro obtient la première tabulation définie, iTab = 1 obtient le deuxième onglet défini, et ainsi de suite. Le tableau suivant récapitule toutes les valeurs possibles d’iTab.

Ccfi	Valeur	Signification
tomTabBack	–3	Onglet Obtenir avant * ptbPos
tomTabNext	–2	Obtenir l’onglet suivant * ptbPos
tomTabHere	–1	Obtenir l’onglet sur * ptbPos
	>= 0	Obtenir l’onglet avec l’index iTab (et ignorer ptbPos).

ptbPos

Type : float*

Déplacement de tabulation, en points à virgule flottante. La valeur de * ptbPos est zéro si l’onglet n’existe pas et la valeur de * ptbPos est tomUndefined s’il existe plusieurs valeurs dans la plage associée.

ptbAlign

Type : long*

Alignement de l’onglet. Pour plus d’informations, consultez ITextPara ::AddTab.

ptbLeader

Type : long*

Style de caractère de leader de l’onglet. Pour plus d’informations, consultez ITextPara ::AddTab.

Valeur retournée

Type : HRESULT

Si ITextPara ::GetTab réussit, il retourne S_OK. Si la méthode échoue, elle retourne l’un des codes d’erreur COM suivants. Pour plus d’informations sur les codes d’erreur COM, consultez Gestion des erreurs dans COM.

Code de retour	Description
Valeur	Signification
E_INVALIDARG	Argument non valide.
CO_E_RELEASED	L’objet de mise en forme de paragraphe est attaché à une plage qui a été supprimée.
S_FALSE	Il n’existe aucun onglet correspondant à iTab.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2003 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	tom.h
DLL	Msftedit.dll