Fonction d’échappement (wingdi.h)

Article
08/27/2023

La fonction d’échappement permet à une application d’accéder aux fonctionnalités d’appareil définies par le système qui ne sont pas disponibles via GDI. Les appels d’échappement effectués par une application sont traduits et envoyés au pilote.

Syntaxe

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

Paramètres

[in] hdc

Handle pour le contexte de l’appareil.

[in] iEscape

Fonction d’échappement à exécuter. Ce paramètre doit être l’une des valeurs d’échappement prédéfinies répertoriées dans remarques. Utilisez la fonction ExtEscape si votre application définit une valeur d’échappement privée.

[in] cjIn

Nombre d’octets de données pointés vers le paramètre lpvInData . Cela peut être 0.

[in] pvIn

Pointeur vers la structure d’entrée requise pour l’échappement spécifié.

[out] pvOut

Pointeur vers la structure qui reçoit la sortie de cette sortie d’échappement. Ce paramètre doit avoir la valeur NULL si aucune donnée n’est retournée.

Valeur retournée

Si la fonction réussit, la valeur de retour est supérieure à zéro, sauf avec l’échappement de l’imprimante QUERYESCSUPPORT , qui vérifie uniquement l’implémentation. Si l’échappement n’est pas implémenté, la valeur de retour est zéro.

Si la fonction échoue, la valeur de retour est un code d’erreur système.

Remarques

Note Il s’agit d’une fonction bloquante ou synchrone qui peut ne pas être retournée immédiatement. La rapidité avec laquelle cette fonction retourne dépend de facteurs d’exécution tels que l’status réseau, la configuration du serveur d’impression et l’implémentation du pilote d’imprimante, facteurs difficiles à prédire lors de l’écriture d’une application. L’appel de cette fonction à partir d’un thread qui gère l’interaction avec l’interface utilisateur peut donner l’impression que l’application ne répond pas.

L’effet du passage de 0 pour cbInput dépend de la valeur de nEscape et du pilote qui gère l’échappement.

Parmi les échappements d’imprimante d’origine, seuls les éléments suivants peuvent être utilisés.

Caractère d'échappement	Description
QUERYESCSUPPORT	Détermine si une échappement particulière est implémentée par le pilote de périphérique.
PASSTHROUGH	Permet à l’application d’envoyer des données directement à une imprimante.

Pour plus d’informations sur les échappements d’imprimante, consultez ExtEscape.

Utilisez la fonction StartPage pour préparer le pilote d’imprimante à recevoir des données.

Configuration requise


Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	wingdi.h (inclure Windows.h)
Bibliothèque	Gdi32.lib
DLL	Gdi32.dll