Función TabbedTextOutA (winuser.h)

Artículo
08/28/2023

La función TabbedTextOut escribe una cadena de caracteres en una ubicación especificada, expandiendo pestañas a los valores especificados en una matriz de posiciones de tabulación. El texto se escribe en la fuente, el color de fondo y el color del texto seleccionados actualmente.

Sintaxis

LONG TabbedTextOutA(
  [in] HDC       hdc,
  [in] int       x,
  [in] int       y,
  [in] LPCSTR    lpString,
  [in] int       chCount,
  [in] int       nTabPositions,
  [in] const INT *lpnTabStopPositions,
  [in] int       nTabOrigin
);

Parámetros

[in] hdc

Identificador del contexto del dispositivo.

[in] x

Coordenada x del punto inicial de la cadena, en unidades lógicas.

[in] y

Coordenada y del punto inicial de la cadena, en unidades lógicas.

[in] lpString

Puntero a la cadena de caracteres que se va a dibujar. La cadena no necesita terminar en cero, ya que nCount especifica la longitud de la cadena.

[in] chCount

Longitud de la cadena a la que apunta lpString.

[in] nTabPositions

Número de valores de la matriz de posiciones de tabulación.

[in] lpnTabStopPositions

Puntero a una matriz que contiene las posiciones de tabulación, en unidades lógicas. Las tabulaciones deben ordenarse en orden creciente; el valor x más pequeño debe ser el primer elemento de la matriz.

[in] nTabOrigin

Coordenada x de la posición inicial desde la que se expanden las pestañas, en unidades lógicas.

Valor devuelto

Si la función se realiza correctamente, el valor devuelto es las dimensiones, en unidades lógicas, de la cadena. El alto está en la palabra de orden superior y el ancho está en la palabra de orden inferior.

Si la función no se realiza correctamente, el valor devuelto es cero.

Comentarios

Si el parámetro nTabPositions es cero y el parámetro lpnTabStopPositions es NULL, las pestañas se expanden a ocho veces el ancho medio de caracteres.

Si nTabPositions es 1, las tabulaciones se separan por la distancia especificada por el primer valor de la matriz lpnTabStopPositions .

Si la matriz lpnTabStopPositions contiene más de un valor, se establece una tabulación para cada valor de la matriz, hasta el número especificado por nTabPositions.

El parámetro nTabOrigin permite a una aplicación llamar a la función TabbedTextOut varias veces para una sola línea. Si la aplicación llama a TabbedTextOut más de una vez con el valor nTabOrigin establecido en el mismo valor cada vez, la función expande todas las pestañas relativas a la posición especificada por nTabOrigin.

De forma predeterminada, la función TabbedTextOut no usa ni actualiza la posición actual. Si una aplicación necesita actualizar la posición actual cuando llama a TabbedTextOut, la aplicación puede llamar a la función SetTextAlign con el parámetro wFlags establecido en TA_UPDATECP. Cuando se establece esta marca, el sistema omite los parámetros X e Y en las llamadas posteriores a la función TabbedTextOut , mediante la posición actual en su lugar.

Nota Para Windows Vista y versiones posteriores, TabbedTextOut omite la alineación del texto cuando dibuja texto.

Nota

El encabezado winuser.h define TabbedTextOut como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	winuser.h (incluir Windows.h)
Library	User32.lib
Archivo DLL	User32.dll
Conjunto de API	ext-ms-win-ntuser-misc-l1-5-1 (introducido en Windows 10, versión 10.0.14393)