Share via


Méthode IPrintOemDriverUni ::D rvGetGPDData (prcomoem.h)

La IPrintOemDriverUni::DrvGetGPDData méthode est fournie par le pilote Unidrv afin que les plug-ins de rendu puissent obtenir des données définies dans le fichier GPD d’une imprimante.

Syntaxe

HRESULT DrvGetGPDData(
  PDEVOBJ pdevobj,
  DWORD   dwType,
  PVOID   pInputData,
  PVOID   pBuffer,
  DWORD   cbSize,
  PDWORD  pcbNeeded
);

Paramètres

pdevobj

Pointeur fourni par l’appelant vers une structure DEVOBJ .

dwType

Indicateur fourni par l’appelant indiquant le type de données GPD demandées. Actuellement, l’indicateur suivant est le seul défini :

Indicateur Définition
GPD_OEMCUSTOMDATA La méthode retourne la chaîne associée à l’entrée *OEMCustomData d’un fichier GPD.

pInputData

Réservé. Doit être zéro.

pBuffer

Pointeur fourni par l’appelant vers une mémoire tampon pour recevoir les informations demandées.

cbSize

Taille fournie par l’appelant, en octets, de la mémoire tampon pointée par pBuffer.

pcbNeeded

Reçoit la taille minimale de mémoire tampon fournie par le pilote, en octets, requise pour contenir les informations demandées.

Valeur retournée

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

Code de retour Description
S_OK
L’opération a réussi.
E_FAIL
L'opération a échoué.
E_NOTIMPL
Cette méthode n'est pas implémentée.

Remarques

Si la mémoire tampon spécifiée par pBuffer et cbSize est trop petite pour recevoir les informations demandées, Unidrv fournit la taille de mémoire tampon requise à l’emplacement pointé par pcbNeeded, retourne E_FAIL et définit le code d’erreur sur ERROR_INSUFFICIENT_BUFFER.

Configuration requise

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