Méthode IPrintOemUni2 ::WritePrinter (prcomoem.h)

Article
02/26/2024

La IPrintOemUni2::WritePrinter méthode, si elle est prise en charge, permet à un plug-in de rendu de capturer toutes les données de sortie générées par un pilote Unidrv. Si cette méthode n’est pas prise en charge, les données de sortie sont sinon envoyées au spouleur dans un appel à l’API WritePrinter du spouleur (décrit dans la documentation Microsoft Windows SDK).

Syntaxe

HRESULT WritePrinter(
  PDEVOBJ pdevobj,
  PVOID   pBuf,
  DWORD   cbBuffer,
  PDWORD  pcbWritten
);

Paramètres

pdevobj

Pointeur vers une structure DEVOBJ .

pBuf

Pointeur vers le premier octet d’un tableau d’octets qui contient les données de sortie générées par le pilote Unidrv.

cbBuffer

Spécifie la taille, en octets, du tableau pointé par pBuf.

pcbWritten

Pointeur vers une valeur DWORD qui reçoit le nombre d’octets de données qui ont été correctement envoyés au plug-in.

Valeur retournée

Si elle réussit, cette méthode retourne S_OK. Sinon, cette méthode doit retourner une valeur appropriée dans le HRESULT retourné.

Remarques

Au moment de DrvEnablePDEV , le pilote Unidrv appelle cette méthode avec pBuf et pdevobj définis sur NULL, et cbBuf sur 0, pour détecter si le plug-in implémente cette fonction. Le plug-in doit retourner S_OK pour indiquer qu’il implémente cette méthode, et doit retourner E_NOTIMPL dans le cas contraire.

Cette méthode doit signaler le nombre d’octets écrits dans la fonction WritePrinter du spouleur dans pcbWritten. Une valeur de zéro n’a pas de signification particulière ; les erreurs doivent être signalées via le HRESULT retourné.

La IPrintOemUni2::WritePrinter méthode est facultative. Si un plug-in de rendu implémente cette méthode, la méthode IPrintOemUni ::GetImplementedMethod du plug-in doit retourner S_OK lorsqu’il reçoit « WritePrinter » comme entrée.

Configuration requise

Condition requise	Valeur
Plateforme cible	Desktop (Expérience utilisateur)
En-tête	prcomoem.h (include Prcomoem.h)

Partager via