Partager via


IPrintOemDriverUni ::D rvWriteAbortBuf, méthode (prcomoem.h)

La méthode IPrintOemDriverUni::DrvWriteAbortBuf est fournie par le pilote Unidrv pour permettre à un plug-in de rendu oem de rendu d’envoyer du code de nettoyage de l’imprimante une fois qu’un utilisateur a terminé une tâche d’impression.

Syntaxe

HRESULT DrvWriteAbortBuf(
  PDEVOBJ pdevobj,
  PVOID   pBuffer,
  DWORD   cbSize,
  DWORD   dwWait
);

Paramètres

pdevobj

Pointeur fourni par l’appelant vers une structure DEVOBJ.

pBuffer

Pointeur fourni par l’appelant vers une mémoire tampon contenant un fragment de code à envoyer à l’imprimante.

cbSize

Nombre d’octets fournis par l’appelant dans la mémoire tampon pointée par pBuffer .

dwWait

Durée fournie par l’appelant pendant laquelle l’imprimante doit attendre, en millisecondes, avant de pouvoir démarrer un nouveau travail d’impression après l’abandon du travail actuel.

Valeur de retour

La méthode doit retourner l’une des valeurs suivantes.

Retourner le code Description
S_OK
L’opération a réussi.
E_FAIL
L’opération a échoué.
E_NOTIMPL
La méthode n’est pas implémentée.

Remarques

Les OEM utilisent IPrintOemDriverUni ::D rvWriteSpoolBuf pour envoyer la sortie à l’imprimante. Si un travail d’impression est arrêté par l’utilisateur, IPrintOemDriverUni::DrvWriteSpoolBuf retourne E_FAIL et ne peut plus être utilisé pour envoyer des données à l’imprimante. Lorsque cela se produit, certaines imprimantes doivent avoir un fragment de code de nettoyage envoyé à eux, réinitialisant leurs états avant de pouvoir démarrer de nouveaux travaux d’impression. Pour ces imprimantes, IPrintOemDriverUni::DrvWritetAbortBuf est utilisé pour envoyer ce fragment de code à l’imprimante.

IPrintOemDriverUni::DrvWriteAbortBuf ne peut être appelé qu’après IPrintOemDriverUni::DrvWriteSpoolBuf a retourné E_FAIL. IPrintOemDriverUni::DrvWriteAbortBuf ne doit pas être appelé plusieurs fois par travail.

Les plug-ins de rendu sont décrits dans Personnalisation des pilotes d’imprimantes microsoft.

Exigences

Exigence Valeur
plateforme cible Bureau
d’en-tête prcomoem.h (include Prcomoem.h)