Struttura COMPROPSHEETUI (compstui.h)

  • Articolo

La struttura COMPROPSHEETUI viene usata come parametro di input per la funzione ComPropSheet di CPSUI , se il codice della funzione è CPSFUNC_ADD_PCOMPROPSHEETUI. Tutti i membri della struttura devono essere forniti dal chiamante di ComPropSheet.

Sintassi

typedef struct _COMPROPSHEETUI {
  WORD           cbSize;
  WORD           Flags;
  HINSTANCE      hInstCaller;
  LPTSTR         pCallerName;
  ULONG_PTR      UserData;
  LPTSTR         pHelpFile;
  _CPSUICALLBACK pfnCallBack;
  POPTITEM       pOptItem;
  PDLGPAGE       pDlgPage;
  WORD           cOptItem;
  WORD           cDlgPage;
  ULONG_PTR      IconID;
  LPTSTR         pOptItemName;
  WORD           CallerVersion;
  WORD           OptItemVersion;
  ULONG_PTR      dwReserved[4];
} COMPROPSHEETUI, *PCOMPROPSHEETUI;

Members

cbSize

Dimensioni fornite dal chiamante, in byte, della struttura COMPROPSHEETUI .

Flags

Flag di bit forniti dal chiamante facoltativo, come descritto nell'elenco seguente:

CPSUIF_ABOUT_CALLBACK

Se impostato, la funzione di callback della pagina (a cui fa riferimento il membro pfnCallback della struttura), supporta CPSUICB_REASON_ABOUT, quindi CPSUI chiamerà la funzione di callback se l'utente fa clic sul pulsante About della pagina. (CPSUI fornisce un pulsante Informazioni per ogni nodo radice di treeview.

CPSUIF_ICONID_AS_HICON

Se impostato, il membro IconID della struttura contiene un handle icona.

Se non è impostato, il membro IconID contiene un identificatore di risorsa icona.

CPSUIF_UPDATE_PERMISSION

Se impostato, i valori dell'opzione della pagina possono essere modificati dall'utente.

hInstCaller

Handle dell'istanza del modulo fornita dal chiamante, ricevuto dalla funzione del punto di ingresso della DLL.

pCallerName

Puntatore fornito dal chiamante a una stringa di testo con terminazione NULL che rappresenta il nome dell'applicazione. Per una DLL dell'interfaccia della stampante, questo deve essere il nome del driver, ad esempio "PostScript Driver".

UserData

Valore fornito dal chiamante facoltativo, che CPSUI inserisce in un membro UserDatadella struttura CPSUICBPARAM quando si chiama la funzione puntata da pfnCallBack.

pHelpFile

Puntatore fornito dal chiamante a una stringa di testo con terminazione NULL che rappresenta un percorso di un file della Guida. Per le DLL dell'interfaccia della stampante, questo è in genere il percorso del file della Guida ottenuto chiamando GetPrinterDriver.

Il file della Guida viene indicizzato da valori contenuti nel membro HelpIndex delle strutture OPTITEM .

pfnCallBack

Puntatore fornito dal chiamante a una funzione di callback _CPSUICALLBACK tipizzata, che CPSUI chiama quando un utente modifica i valori dell'opzione della pagina.

Può essere usato solo se pDlgPage identifica una struttura DLGPAGE fornita da CPSUI o se il membro DlgProc di una struttura DLGPAGE fornita dall'applicazione è NULL.

pOptItem

Puntatore fornito dal chiamante a una matrice di strutture OPTITEM che descrivono le opzioni della pagina.

pDlgPage

Questo membro specifica le strutture DLGPAGE che descrivono le pagine da aggiungere al foglio delle proprietà. Può essere uno dei seguenti:

  • Puntatore a una matrice di strutture DLGPAGE.

  • Uno dei puntatori descritti nell'elenco seguente. Questi puntatori fanno riferimento alle strutture DLGPAGE predefinite, fornite da CPSUI per l'uso da DLL dell'interfaccia della stampante.

    • CPSUI_PDLGPAGE_ADVDOCPROP

      Definisce una pagina di visualizzazione albero la cui scheda legge Avanzate. Per l'uso solo da una funzione DrvDocumentPropertySheets .

    • CPSUI_PDLGPAGE_DOCPROP

      Definisce tre pagine, le cui schede sono Layout, Carta/Qualità e Avanzate. La pagina Avanzate è una visualizzazione albero. Per l'uso solo da una funzione DrvDocumentPropertySheets .

    • CPSUI_PDLGPAGE_PRINTERPROP

      Definisce una pagina di visualizzazione albero la cui scheda legge Impostazioni dispositivo. Per l'uso solo da una funzione DrvDevicePropertySheets .

    • CPSUI_PDLGPAGE_TREEVIEWONLY

      Definisce una pagina di visualizzazione albero.

cOptItem

Numero fornito dal chiamante di strutture OPTITEM a cui fa riferimento pOptItem.

cDlgPage

Numero fornito dal chiamante di strutture DLGPAGE a cui fa riferimento pDlgPage. Non usato se pDlgPage specifica una struttura predefinita CPSUI_PDLGPAGE prefisso.

IconID

Il chiamante fornito può essere uno dei seguenti:

  • Identificatore di risorsa icona. Può essere definito dall'applicazione oppure può essere uno degli identificatori di risorsa dell'icona con prefisso CPSUI fornito da IDI_CPSUI CPSUI.

  • Handle icona. Se viene specificato un handle, CPSUIF_ICONID_AS_HICON deve essere impostato nel membro Flags .

L'icona specificata viene visualizzata nel nodo radice della visualizzazione albero della pagina del foglio delle proprietà.

pOptItemName

Puntatore fornito dal chiamante a una stringa con terminazione NULL da visualizzare nel nodo radice della visualizzazione albero della pagina del foglio delle proprietà. Per le DLL dell'interfaccia della stampante, questa stringa rappresenta in genere un tipo di dispositivo stampante, ad esempio "HP 4si".

CallerVersion

Numero di versione fornito dal chiamante, che rappresenta la versione corrente dell'applicazione chiamante. Il byte elevato identifica la versione principale e il byte basso è la versione secondaria. Ad esempio, un valore CallerVersion di 0x310 specifica un numero di versione del chiamante pari a 3.16. Il numero di versione viene visualizzato quando un utente fa clic sul pulsante Informazioni su una pagina.

OptItemVersion

Numero di versione fornito dal chiamante, che rappresenta la versione corrente dell'elemento dell'opzione a livello radice. Per le DLL dell'interfaccia della stampante, questo rappresenta in genere una versione del dispositivo stampante. Il byte elevato identifica la versione principale e il byte basso è la versione secondaria. Ad esempio, un valore OptItemVersion di 0x3ff specifica un numero di versione del chiamante pari a 3.255. Il numero di versione viene visualizzato quando un utente fa clic sul pulsante Informazioni su una pagina.

dwReserved[4]

Riservato. Questa matrice deve essere impostata su zero.

Requisiti

Requisito Valore
Intestazione compstui.h (include Compstui.h)