Función Escape (wingdi.h)

Artículo
03/08/2023

La función Escape permite a una aplicación acceder a las funcionalidades de dispositivo definidas por el sistema que no están disponibles a través de GDI. Las llamadas de escape realizadas por una aplicación se traducen y envían al controlador.

Sintaxis

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

Parámetros

[in] hdc

Identificador del contexto del dispositivo.

[in] iEscape

Función de escape que se va a realizar. Este parámetro debe ser uno de los valores de escape predefinidos enumerados en Comentarios. Use la función ExtEscape si la aplicación define un valor de escape privado.

[in] cjIn

Número de bytes de datos a los que apunta el parámetro lpvInData . Puede ser 0.

[in] pvIn

Puntero a la estructura de entrada necesaria para el escape especificado.

[out] pvOut

Puntero a la estructura que recibe la salida de este escape. Este parámetro debe ser NULL si no se devuelve ningún dato.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es mayor que cero, excepto con el escape de impresora QUERYESCSUPPORT , que comprueba solo la implementación. Si no se implementa el escape, el valor devuelto es cero.

Si se produce un error en la función, el valor devuelto es un código de error del sistema.

Comentarios

Nota Se trata de una función de bloqueo o sincrónica y podría no devolverse inmediatamente. La rapidez con la que devuelve esta función depende de factores en tiempo de ejecución, como el estado de red, la configuración del servidor de impresión y la implementación del controlador de impresora, factores que son difíciles de predecir al escribir una aplicación. Llamar a esta función desde un subproceso que administra la interacción con la interfaz de usuario podría hacer que la aplicación parezca que no responde.

El efecto de pasar 0 para cbInput dependerá del valor de nEscape y del controlador que controla el escape.

De los escapes de impresora originales, solo se puede usar lo siguiente.

Escape	Descripción
QUERYESCSUPPORT	Determina si el controlador de dispositivo implementa un escape determinado.
PASSTHROUGH	Permite que la aplicación envíe datos directamente a una impresora.

Para obtener información sobre los escapes de impresora, consulte ExtEscape.

Use la función StartPage para preparar el controlador de impresora para recibir datos.

Requisitos


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	wingdi.h (incluye Windows.h)
Library	Gdi32.lib
Archivo DLL	Gdi32.dll