Funzione CommonPropertySheetUIW (compstui.h)

La funzione CommonPropertySheetUI di CPSUI visualizza le pagine della finestra delle proprietà e consente all'utente di apportare modifiche ai valori visualizzati.

Sintassi

LONG CommonPropertySheetUIW(
  HWND           hWndOwner,
  PFNPROPSHEETUI pfnPropSheetUI,
  LPARAM         lParam,
  LPDWORD        pResult
);

Parametri

hWndOwner

Handle della finestra fornita dal chiamante che identifica la finestra in cui posizionare le nuove pagine della finestra delle proprietà.

pfnPropSheetUI

Puntatore fornito dal chiamante a una funzione di callback tipizzata PFNPROPSHEETUI.

lParam

Valore fornito dal chiamante utilizzato come argomento di input per la funzione pfnPropSheetUI . Questo valore può essere un puntatore.

pResult

Puntatore fornito dal chiamante a un DWORD che riceve lo stato di restituzione finale della funzione pfnPropSheetUI . Se NULL, lo stato restituito finale non viene restituito. Per altre informazioni, vedere la sezione Osservazioni di seguito.

Valore restituito

La funzione CommonPropertySheetUI restituisce uno dei valori seguenti:

Codice restituito	Descrizione
CPSUI_CANCEL	La funzione pfnPropSheetUI ha restituito un valore negativo.
CPSUI_OK	Operazione completata.
CPSUI_REBOOTSYSTEM	L'operazione è riuscita e una routine della finestra di dialogo ha inviato il messaggio PSM_REBOOTSYSTEM .
CPSUI_RESTARTWINDOWS	L'operazione è riuscita e una routine della finestra di dialogo ha inviato il messaggio PSM_RESTARTWINDOWS .
codice di errore con prefisso ERR_CPSUI	Si è verificato un errore. I codici di errore con prefisso ERR_CPSUI sono definiti in compstui.h.

Commenti

La funzione CommonPropertySheetUI è il punto di ingresso di CPSUI per le applicazioni. Un'applicazione CPSUI(ad esempio lo spooler di stampa del sistema operativo basato su Microsoft NT) può chiamare la funzione per aggiungere una o più pagine della finestra delle proprietà a una finestra padre predefinita. CPSUI visualizza le pagine, consente all'utente di modificarle e di notificare l'applicazione dell'attività utente tramite le funzioni di callback.

Lo spooler di stampa basato su NT chiama la funzione CommonPropertySheetUI quando un'applicazione Win32 chiama le funzioni DocumentProperties o PrinterProperties dello spooler.

La funzione di callback specificata dal parametro pfnPropSheetUI è responsabile dell'aggiunta delle pagine della finestra delle proprietà. Per altre informazioni, vedere la descrizione del tipo di funzione PFNPROPSHEETUI .

La sequenza di operazione è la seguente:

1. La funzione CommonPropertySheetUI chiama il callback pfnPropSheetUI in modo che il callback possa descrivere le pagine da aggiungere chiamando la funzione ComPropSheet di CPSUI.

2. Se il callback pfnPropSheetUI ha esito positivo, la funzione CommonPropertySheetUI visualizza le nuove pagine della finestra delle proprietà e consente all'utente di modificare i valori della pagina.

3. Se l'utente modifica i valori della pagina, un callback dell'evento di pagina invia una notifica all'applicazione delle modifiche.

4. Quando l'utente sceglie il pulsante OK o Annulla , la funzione CommonPropertySheetUI elimina definitivamente le pagine visualizzate e restituisce.

Per altre informazioni sulla sequenza di funzionamento, vedere Uso di CPSUI con i driver della stampante, nella sezione intitolata CPSUI.

La funzione CommonPropertySheetUI chiama effettivamente il callback pfnPropSheetUI più volte, specificando diversi valori membro Reason nella struttura PROPSHEETUI_INFO del callback. Ogni volta che il callback viene restituito, inserisce lo stato del risultato nel membro Result della struttura PROPSHEETUI_INFO. Quando viene restituita la funzione CommonPropertySheetUI , copia il contenuto finale di Result nella posizione a cui punta pResult.

Requisiti

Requisito	Valore
Piattaforma di destinazione	Desktop
Intestazione	compstui.h (include Compstui.h)