Función GetTabbedTextExtentA (winuser.h)

La función GetTabbedTextExtent calcula el ancho y el alto de una cadena de caracteres. Si la cadena contiene uno o más caracteres de tabulación, el ancho de la cadena se basa en las tabulaciones especificadas. La función getTabbedTextExtent usa la fuente seleccionada actualmente para calcular las dimensiones de la cadena.

Sintaxis

DWORD GetTabbedTextExtentA(
  [in] HDC       hdc,
  [in] LPCSTR    lpString,
  [in] int       chCount,
  [in] int       nTabPositions,
  [in] const INT *lpnTabStopPositions
);

Parámetros

[in] hdc

Identificador del contexto del dispositivo.

[in] lpString

Puntero a una cadena de caracteres.

[in] chCount

Longitud de la cadena de texto. Para la función ANSI, es un recuento de BYTES y para la función Unicode es un recuento de WORD. Tenga en cuenta que para la función ANSI, los caracteres de las páginas de códigos SBCS toman un byte cada uno, mientras que la mayoría de los caracteres de las páginas de códigos DBCS toman dos bytes; para la función Unicode, la mayoría de los caracteres Unicode definidos actualmente (los del plano multilingüe básico (BMP)) son una PALABRA mientras que los suplentes Unicode son dos WORD.

[in] nTabPositions

Número de posiciones de tabulación en la matriz a las que apunta el parámetro lpnTabStopPositions.

[in] lpnTabStopPositions

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

Valor devuelto

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

Si se produce un error en la función, el valor devuelto es 0. GetTabbedTextExtent producirá un error si hDC no es válido y si nTabPositions es menor que 0.

Observaciones

La región de recorte actual no afecta al ancho y alto devuelto por la función GetTabbedTextExtent.

Dado que algunos dispositivos no colocan caracteres en matrices de celdas normales (es decir, a kern los caracteres), la suma de las extensiones de los caracteres de una cadena puede no ser igual a la extensión de la cadena.

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 a la que puntos de lpnTabStopPositions.

Nota

El encabezado winuser.h define GetTabbedTextExtent 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 Conventions for Function Prototypes.

Requisitos

Requisito	Valor
cliente mínimo admitido	Windows 2000 Professional [solo aplicaciones de escritorio]
servidor mínimo admitido	Windows 2000 Server [solo aplicaciones de escritorio]
de la plataforma de destino de	Windows
encabezado de	winuser.h (incluya Windows.h)
biblioteca de	User32.lib
DLL de	User32.dll

Consulte también

funciones de fuente y texto de

de información general de fuentes y texto de

GetTextExtentPoint32

tabbedTextOut de