Metodo IPrintOemUI::CommonUIProp (prcomoem.h)

Il IPrintOemUI::CommonUIProp metodo consente a un plug-in dell'interfaccia utente di modificare una pagina delle proprietà della stampante esistente.

Sintassi

HRESULT CommonUIProp(
  DWORD         dwMode,
  POEMCUIPPARAM pOemCUIPParam
);

Parametri

dwMode

Costante integer fornita dal chiamante che indica quale pagina del foglio delle proprietà deve essere modificata. Le costanti seguenti sono valide.

valore Definizione
OEMCUIP_DOCPROP Il metodo viene chiamato per modificare la pagina Layout, Paper/Quality o Advanced del foglio delle proprietà del documento.
OEMCUIP_PRNPROP Il metodo viene chiamato per modificare la pagina Impostazioni dispositivo del foglio delle proprietà della stampante.

pOemCUIPParam

Puntatore fornito dal chiamante a una struttura OEMCUIPPARAM .

Valore restituito

Il metodo deve restituire uno dei valori seguenti.

Codice restituito Descrizione
S_OK
Operazione completata.
E_FAIL
Operazione non riuscita.
E_NOTIMPL
Il metodo non è implementato.

Commenti

Quando viene chiamato un metodo plug-in dell'interfaccia IPrintOemUI::CommonUIProp utente, deve restituire elementi dell'opzione del foglio delle proprietà personalizzati per modificare una pagina della finestra delle proprietà della stampante esistente.

Il IPrintOemUI::CommonUIProp metodo viene chiamato dalla DLL dell'interfaccia della stampante del driver della stampante. Il metodo deve fornire una matrice di strutture OPTITEM che descrivono gli elementi del foglio delle proprietà, insieme a una funzione di callback per l'elaborazione delle modifiche utente ai valori delle opzioni.

Si prevede che il metodo venga chiamato due volte per ogni foglio delle proprietà. Il valore del parametro dwMode del metodo indica se viene chiamato per apportare modifiche al foglio delle proprietà della stampante o al foglio delle proprietà del documento.

La prima volta che viene chiamata, il metodo deve restituire solo il numero di strutture OPTITEM da aggiungere. Questo numero deve essere inserito nel membro cOEMOptItems della struttura OEMCUIPPARAM. La DLL dell'interfaccia della stampante alloca quindi memoria sufficiente per archiviare il numero specificato di VM OPTITE e le chiamate IPrintOemUI::CommonUIProp di nuovo.

La seconda volta che viene chiamata, il IPrintOemUI::CommonUIProp metodo deve eseguire le operazioni seguenti:

  • Compilare la matrice fornita dal driver di strutture OPTITEM con descrizioni delle opzioni. Questa matrice è puntata dal membro pOEMOptItems della struttura OEMCUIPPARAM e il numero di elementi della matrice allocati è contenuto nel membro cOEMOptItems della struttura. Per informazioni sulla specifica dei valori dei membri OPTITEM, vedere la descrizione del membro pOEMOptItems della struttura OEMCUIPPARAM.
  • Restituisce il numero di strutture aggiunte alla matrice OPTITEM inserendo il numero nel membro cOEMOptItems della struttura OEMCUIPPARAM.
  • Restituire l'indirizzo di una funzione di callback nel membro OEMCUIPPARAM della struttura OEMCUIPCallback . Questa funzione di callback viene chiamata quando un utente modifica la pagina del foglio delle proprietà. La funzione di callback deve essere di tipo OEMCUIPCALLBACK.
  • Facoltativamente, restituire l'indirizzo di una struttura di dati privata inserendolo nel membro pOEMUserData della struttura OEMCUIPPARAM. La funzione di callback specificata dal membro OEMCUIPCallback della struttura riceve l'indirizzo della struttura OEMCUIPPARAM come parametro di input e può quindi ottenere l'indirizzo dei dati privati.

    Lo spazio per la struttura dati privata deve essere allocato chiamando la funzione heapAlloc Microsoft Windows SDK, usando l'handle contenuto nel membro hOEMHeap della struttura OEMCUIPPARAM.

Se IPrintOemUI::CommonUIProp i metodi vengono esportati da più plug-in dell'interfaccia utente, i metodi vengono chiamati nell'ordine in cui vengono specificati i plug-in per l'installazione.

Per altre informazioni, vedere Modifica di una pagina foglio delle proprietà Driver-Supplied.

Requisiti

Requisito Valore
Piattaforma di destinazione Desktop
Intestazione prcomoem.h (include Prcomoem.h)