Função TabbedTextOutA (winuser.h)

Artigo
08/28/2023

A função TabbedTextOut grava uma cadeia de caracteres em um local especificado, expandindo as guias para os valores especificados em uma matriz de posições de parada de tabulação. O texto é escrito na fonte, na cor da tela de fundo e na cor do texto selecionadas no momento.

Sintaxe

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

Um identificador para o contexto do dispositivo.

[in] x

A coordenada x do ponto de partida da cadeia de caracteres, em unidades lógicas.

[in] y

A coordenada y do ponto de partida da cadeia de caracteres, em unidades lógicas.

[in] lpString

Um ponteiro para a cadeia de caracteres a ser desenhada. A cadeia de caracteres não precisa ser terminada em zero, pois nCount especifica o comprimento da cadeia de caracteres.

[in] chCount

O comprimento da cadeia de caracteres apontada por lpString.

[in] nTabPositions

O número de valores na matriz de posições de parada de tabulação.

[in] lpnTabStopPositions

Um ponteiro para uma matriz que contém as posições de parada de tabulação, em unidades lógicas. As paradas de tabulação devem ser classificadas em ordem crescente; o menor valor x deve ser o primeiro item na matriz.

[in] nTabOrigin

A coordenada x da posição inicial da qual as guias são expandidas, em unidades lógicas.

Retornar valor

Se a função for bem-sucedida, o valor retornado será as dimensões, em unidades lógicas, da cadeia de caracteres. A altura está na palavra de alta ordem e a largura está na palavra de ordem baixa.

Se a função falhar, o valor retornado será zero.

Comentários

Se o parâmetro nTabPositions for zero e o parâmetro lpnTabStopPositions for NULL, as guias serão expandidas para oito vezes a largura média do caractere.

Se nTabPositions for 1, as paradas de tabulação serão separadas pela distância especificada pelo primeiro valor na matriz lpnTabStopPositions .

Se a matriz lpnTabStopPositions contiver mais de um valor, uma parada de tabulação será definida para cada valor na matriz, até o número especificado por nTabPositions.

O parâmetro nTabOrigin permite que um aplicativo chame a função TabbedTextOut várias vezes para uma única linha. Se o aplicativo chamar TabbedTextOut mais de uma vez com o nTabOrigin definido como o mesmo valor a cada vez, a função expandirá todas as guias em relação à posição especificada por nTabOrigin.

Por padrão, a posição atual não é usada ou atualizada pela função TabbedTextOut . Se um aplicativo precisar atualizar a posição atual ao chamar TabbedTextOut, o aplicativo poderá chamar a função SetTextAlign com o parâmetro wFlags definido como TA_UPDATECP. Quando esse sinalizador é definido, o sistema ignora os parâmetros X e Y em chamadas subsequentes para a função TabbedTextOut , usando a posição atual.

Nota Para o Windows Vista e posteriores, TabbedTextOut ignora o alinhamento do texto quando desenha texto.

Observação

O cabeçalho winuser.h define TabbedTextOut como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	winuser.h (inclua Windows.h)
Biblioteca	User32.lib
DLL	User32.dll
Conjunto de APIs	ext-ms-win-ntuser-misc-l1-5-1 (introduzido no Windows 10, versão 10.0.14393)