Função escape (wingdi.h)

Artigo
08/27/2023

A função Escape permite que um aplicativo acesse os recursos de dispositivo definidos pelo sistema que não estão disponíveis por meio da GDI. As chamadas de escape feitas por um aplicativo são convertidas e enviadas para o driver.

Sintaxe

int Escape(
  [in]  HDC    hdc,
  [in]  int    iEscape,
  [in]  int    cjIn,
  [in]  LPCSTR pvIn,
  [out] LPVOID pvOut
);

Parâmetros

[in] hdc

Um identificador para o contexto do dispositivo.

[in] iEscape

A função de escape a ser executada. Esse parâmetro deve ser um dos valores de escape predefinidos listados em Comentários. Use a função ExtEscape se o aplicativo definir um valor de escape privado.

[in] cjIn

O número de bytes de dados apontados pelo parâmetro lpvInData . Isso pode ser 0.

[in] pvIn

Um ponteiro para a estrutura de entrada necessária para o escape especificado.

[out] pvOut

Um ponteiro para a estrutura que recebe a saída desse escape. Esse parâmetro deverá ser NULL se nenhum dado for retornado.

Valor retornado

Se a função for bem-sucedida, o valor retornado será maior que zero, exceto com o escape da impressora QUERYESCSUPPORT , que verifica apenas a implementação. Se o escape não for implementado, o valor retornado será zero.

Se a função falhar, o valor retornado será um código de erro do sistema.

Comentários

Nota Essa é uma função de bloqueio ou síncrona e pode não retornar imediatamente. A rapidez com que essa função retorna depende de fatores de tempo de execução, como status de rede, configuração do servidor de impressão e implementação de driver de impressora, fatores difíceis de prever ao escrever um aplicativo. Chamar essa função de um thread que gerencia a interação com a interface do usuário pode fazer com que o aplicativo pareça não responder.

O efeito de passar 0 para cbInput dependerá do valor de nEscape e do driver que está tratando o escape.

Dos escapes originais da impressora, somente o seguinte pode ser usado.

Escape	Descrição
QUERYESCSUPPORT	Determina se um escape específico é implementado pelo driver de dispositivo.
PASSAGEM	Permite que o aplicativo envie dados diretamente para uma impressora.

Para obter informações sobre escapes de impressora, consulte ExtEscape.

Use a função StartPage para preparar o driver de impressora para receber dados.

Requisitos


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	wingdi.h (inclua Windows.h)
Biblioteca	Gdi32.lib
DLL	Gdi32.dll