Structure OEMCUIPPARAM (printoem.h)

La structure OEMCUIPPARAM est utilisée comme paramètre d’entrée pour la méthode IPrintOemUI ::CommonUIProp d’un plug-in d’interface utilisateur.

Syntaxe

typedef struct _OEMCUIPPARAM {
  DWORD           cbSize;
  POEMUIOBJ       poemuiobj;
  HANDLE          hPrinter;
  PWSTR           pPrinterName;
  HANDLE          hModule;
  HANDLE          hOEMHeap;
  PDEVMODE        pPublicDM;
  PVOID           pOEMDM;
  DWORD           dwFlags;
  POPTITEM        pDrvOptItems;
  DWORD           cDrvOptItems;
  POPTITEM        pOEMOptItems;
  DWORD           cOEMOptItems;
  PVOID           pOEMUserData;
  OEMCUIPCALLBACK OEMCUIPCallback;
} *POEMCUIPPARAM, OEMCUIPPARAM;

Membres

cbSize

Taille de la structure OEMCUIPPARAM . Fourni par le pilote Unidrv ou Pscript5.

poemuiobj

Pointeur vers une structure OEMUIOBJ .

hPrinter

Handle à l’imprimante. Fourni par le pilote Unidrv ou Pscript5.

pPrinterName

Chaîne contenant le nom de l’imprimante. Fourni par le pilote Unidrv ou Pscript5.

hModule

Gérez le plug-in d’interface utilisateur. Fourni par le pilote Unidrv ou Pscript5.

hOEMHeap

Handle vers un tas à partir duquel l’espace peut être alloué en appelant la fonction HeapAlloc (décrite dans la documentation Microsoft Windows SDK). Fourni par le pilote Unidrv ou Pscript5.

pPublicDM

Pointeur vers la structure DEVMODEW publique de l’imprimante. Valide uniquement si l’argument dwMode de la méthode IPrintOemUI ::CommonUIProp est OEMCUIP_DOCPROP. Fourni par le pilote Unidrv ou Pscript5.

pOEMDM

Pointeur vers les membres DEVMODEW privés du plug-in d’interface utilisateur. Valide uniquement si l’argument dwMode de la méthode IPrintOemUI ::CommonUIProp est OEMCUIP_DOCPROP. Fourni par le pilote Unidrv ou Pscript5.

dwFlags

Pour les appels à IPrintOemUI ::CommonUIProp avec son paramètre dwMode défini sur OEMCUIP_DOCPROP

Contient le contenu du membre fMode de la structure DOCUMENTPROPERTYHEADER reçu par la fonction DrvDocumentPropertySheets du pilote d’imprimante.

Pour les appels à IPrintOemUI ::CommonUIProp avec son paramètre dwMode défini sur OEMCUIP_PRNPROP

Contient le contenu du membre Flags de la structure DEVICEPROPERTYHEADER reçue par la fonction DrvDevicePropertySheets du pilote d’imprimante.

pDrvOptItems

Pointeur vers le tableau OPTITEM du pilote d’imprimante. Non valide la première fois que IPrintOemUI ::CommonUIProp est appelé. Fourni par le pilote Unidrv ou Pscript5.

cDrvOptItems

Nombre de structures OPTITEM dans le tableau pointé par pDrvOptItems. Fourni par le pilote Unidrv ou Pscript5.

pOEMOptItems

Pointeur vers un tableau de structures OPTITEM . Fourni par l’appelant IPrintOemUI ::CommonUIProp . La deuxième fois que la méthode IPrintOemUI ::CommonUIProp est appelée, elle doit placer les structures OPTITEM définies par le plug-in d’interface utilisateur dans ce tableau et placer le nombre de structures dans cOEMOptItems. Pour chaque structure OPTITEM placée dans le tableau, vous devez effectuer les opérations suivantes :

• Définissez le membre DMPubID de la structure OPTITEM sur l’une des valeurs prédéfinies ou sur une valeur supérieure à DMPUB_USER. Si vous utilisez des valeurs prédéfinies, vous devez rechercher dans l’ensemble du tableau OPTITEM les structures contenant déjà ces valeurs, et vous devez définir leurs indicateurs de OPTIF_HIDE.

• Allouez de l’espace pour les structures OPTTYPES et OPTPARAMS en appelant la fonction HeapAlloc du SDK Windows, à l’aide du handle contenu dans le membre hOEMHeap de la structure OEMCUIPPARAM. Le pilote d’imprimante libère cet espace quand il n’est plus nécessaire.

Non valide la première fois que IPrintOemUI ::CommonUIProp est appelé.

cOEMOptItems

Nombre de structures OPTITEM contenues dans le tableau pointé par pOEMOptItems. Fourni par le pilote Unidrv ou Pscript5.

La première fois que la méthode IPrintOemUI ::CommonUIProp est appelée, la valeur fournie par l’appelant pour cOEMOptItems est égale à zéro. La méthode IPrintOemUI ::CommonUIProp doit modifier cette valeur pour indiquer le nombre de structures OPTITEM que la méthode fournit. La deuxième fois qu’il est appelé, IPrintOemUI ::CommonUIProp doit fournir le nombre de structures OPTITEM réellement ajoutées au tableau pointé par pOEMOptItems.

pOEMUserData

Utilisé par la méthode IPrintOemUI ::CommonUIProp , la deuxième fois qu’elle est appelée, pour fournir à la fonction OEMCUIPCallback des informations d’entrée supplémentaires facultatives.

OEMCUIPCallback

Utilisé par la méthode IPrintOemUI ::CommonUIProp , la deuxième fois qu’il est appelé, pour renvoyer l’adresse d’une fonction de rappel de type OEMCUIPCALLBACK.

Remarques

Un plug-in d’interface utilisateur reçoit l’adresse de cette structure en tant qu’argument d’entrée à la fois pour sa méthode IPrintOemUI ::CommonUIProp et sa fonction de rappel de type OEMCUIPCALLBACK.

Pour plus d’informations sur l’utilisation de cette structure et des fonctions associées, consultez Plug-ins d’interface utilisateur.

Configuration requise