Variáveis-padrão

Importante

A moderna plataforma de impressão é o meio preferido do Windows para comunicar com as impressoras. Recomendamos que utilize o controlador de classe da caixa de entrada IPP da Microsoft, juntamente com as Aplicações de Suporte de Impressão (PSA), para personalizar a experiência de impressão no Windows 10 e 11 para o desenvolvimento de dispositivos de impressora.

Para obter mais informações, consulte a plataforma moderna de impressão e o guia de design do aplicativo de suporte à impressão .

A linguagem GPD define um conjunto de variáveis padrão que podem ser referenciadas dentro de cadeias de comando, usando o formato de cadeia de comando . O driver Unidrv atribui valores a essas variáveis. Do ponto de vista de um arquivo GPD, as variáveis são somente leitura.

Todas as variáveis padrão são armazenadas como inteiros DWORD.

A seguinte entrada de comando da impressora especifica a cadeia de comando que é enviada para uma HP LaserJet 4P quando um bloco de dados raster está pronto:

*Command: CmdSendBlockData: "<1B>*b" %d{NumOfDataBytes} "W"

A tabela a seguir contém todas as variáveis padrão, em ordem alfabética.

Nome da variável padrão	Valor	Observações
BlueValue	Componente azul da cor atual.	Válido para uso em cadeias de caracteres de comando CmdDefinePaletteEntry (consulte GreenValueRedValue).
CurrentFontID	Número de identificação da fonte virtual baixada atual.	Válido se o trabalho de impressão atual incluir fontes suaves baixadas.
ÍndiceAtualDaPaleta	Índice atual na paleta de cores.	Válido para uso nas cadeias de comando CmdSelectPaletteEntry (consulte GreenValue, RedValue).
CursorOriginX	Coordenada X de origem do cursor, em unidades mestras.	Válido sempre que um trabalho de impressão estiver em andamento.
CursorOriginY	Coordenada Y de origem do cursor, em unidades mestras.	Válido sempre que um trabalho de impressão estiver em andamento.
DestX	Coordenada X do destino do cursor, em unidades mestre, em relação à origem do cursor.	Válido para uso em cadeias de comando CmdXMoveAbsolut.
DestXRel	Coordenada X do destino do cursor, em unidades mestras, em relação à posição atual do cursor.	Válido para uso nas cadeias de comando CmdXMoveRelLeft e CmdXMoveRelRight.
DestY	Coordenada Y do destino do cursor, em unidades mestre, em relação à origem do cursor.	Válido para uso em cadeias de comando CmdYMoveAbsolut.
DestYRel	Coordenada Y do destino do cursor, em unidades mestre, em relação à posição atual do cursor.	Válido para uso em cadeias de comando CmdYMoveRelUp e CmdYMoveRelDown.
FontBold	Defina como um se a fonte atual estiver em negrito ou zero caso contrário.	Válido quando uma fonte foi especificada.
AlturaDaFonte	Altura, em unidades mestres, da fonte atual.	Válido quando uma fonte foi especificada.
FontItalic	Defina como um se a fonte atual estiver em itálico ou zero caso contrário.	Válido quando uma fonte foi especificada.
FontMaxWidth	Definido como o incremento máximo de caracteres de todos os glifos em a fonte.	Válido quando uma fonte foi especificada.
FontStrikeThru	Defina 1 se o tachado estiver habilitado para a fonte atual, ou 0, caso contrário.	Válido quando uma fonte foi especificada.
FontUnderLine	Defina como um se a fonte atual estiver sublinhada, ou zero caso contrário.	Válido quando uma fonte foi especificada.
FontWidth	Largura, em unidades mestres, da fonte atual.	Válido quando uma fonte foi especificada.
GraphicsXRes	Resolução horizontal atual para gráficos, em DPI.	Válido sempre que um trabalho de impressão estiver em andamento.
GraphicsYRes	Resolução vertical atual para gráficos, em DPI.	Válido sempre que um trabalho de impressão estiver em andamento.
PercentagemCinza	Nível de cinza (porcentagem) a ser usado para preenchimento cinza.	Válido para uso em cadeias de comando CmdRectGrayFill.
GreenValue	Componente verde da cor atual.	Válido para uso em strings de comando CmdDefinePaletteEntry (consulte BlueValue, RedValue).
LinefeedSpacing	Quantidade de espaço vertical, em unidades mestres, representando uma alimentação de linha.	Válido para uso em cadeias de caracteres de comando CmdSetLineSpacing.
NextFontID	Número de identificação da próxima fonte a ser baixada.	Válido para uso em cadeias de comando CmdSetFontID.
NextGlyph	O código de dois bytes do próximo glifo para download.	Válido para uso em cadeias de comando CmdSetCharCode.
NúmeroDeCópias	Número de cópias solicitadas pelo utilizador.	Válido sempre que um trabalho de impressão estiver em andamento.
NumOfDataBytes	Número de bytes de dados raster prontos para transferência.	Válido para uso em qualquer cadeia de comando CmdSendXXXData. Se os dados forem compactados, o valor será o número de bytes após a compactação.
PageNumber	O número da página que está sendo impressa no momento. Observe que isso não corresponde necessariamente ao número da página do aplicativo, mas sim ao número de vezes que DrvSendPage foi chamado. Esse valor é inicializado por DrvStartDoc e é incrementado pelo DrvSendPage. Por exemplo, se N-up = 4 estiver selecionado, PageNumber será incrementado para 2 somente quando a quinta página do documento estiver sendo impressa. Como outro exemplo, se um documento for impresso em ordem inversa (de trás para frente), a PageNumber variável padrão ainda informará a primeira página a ser impressa como página 1, mesmo que esta seja a última página do documento. Esse comportamento é necessário para suportar corretamente o recurso de duplexação automática. O OEM deve usar PageNumber apenas para determinar se a página atual é a frente ou o verso.	Válido sempre que um trabalho de impressão estiver em andamento.
PaletteIndexToProgram	Indexe na paleta de cores para a próxima entrada do programa.	Válido para uso em cadeias de caracteres de comando CmdDefinePaletteEntry. (Ver também RedValue, GreenValue, BlueValue, CurrentPaletteIndex).
PatternBrushID	Número de identificação de um pincel padrão baixado.	Válido para uso com as cadeias de comando CmdDownloadPattern e CmdSelectPattern.
PatternBrushSize	Tamanho, em bytes, do pincel padrão atual.	Válido para uso com a cadeia de comando CmdDownloadPattern.
PatternBrushType	Tipo de pincel de padrão atual. O valor pode ser: 2: Padrão de sombreamento 3: Padrão de escotilha cruzada 4: Padrão definido pelo usuário.	Válido para uso com as cadeias de comando CmdDownloadPattern e CmdSelectPattern.
PhysPaperLength	Comprimento do papel atualmente em uso, em modo retrato, medido em unidades y-master.	Válido sempre que um trabalho de impressão estiver em andamento.
LarguraFisicaPapel	Largura em modo retrato, em unidades mestras, do papel atualmente em uso.	Válido sempre que um trabalho de impressão estiver em andamento.
PrintDirInCCDegrees	Quantidade de rotação, medida no sentido anti-horário, em graus.	Válido quando o driver envia o comando CmdSetSimpleRotation ou CmdSetAnyRotation.
RasterDataHeightInPixels	Altura, em pixels, da imagem representada pelos dados atuais.	Válido para uso em qualquer cadeia de comando CmdSendXXXData e em cadeias de comando CmdSetSrcBmpHeight. A compactação não modifica esse valor.
RasterDataWidthInBytes	Número de bytes contidos em uma linha de digitalização.	Válido para uso em qualquer cadeia de comando CmdSendXXXData e em cadeias de comando CmdSetSrcBmpWidth. A compactação não modifica esse valor.
RectXSize	Largura do retângulo, em unidades x-master.	Válido para uso em cadeias de comando CmdSetRectWidth.
RectYSize	Comprimento do retângulo, em unidades de y-master.	Válido para uso em cadeias de comando CmdSetRectHeight.
RedValue	Componente vermelho da cor atual.	Válido para utilizar nas sequências de comando CmdDefinePaletteEntry (veja GreenValue, BlueValue).
TextXRes	Resolução horizontal atual para texto, em DPI.	Válido sempre que um trabalho de impressão estiver em andamento.
TextYRes	Resolução vertical atual para texto, em DPI.	Válido sempre que um trabalho de impressão estiver em andamento.