Funzione CommonPropertySheetUIA (compstui.h)

La funzione CommonPropertySheetUI di CPSUI visualizza le pagine del foglio delle proprietà e consente alle modifiche dell'utente di visualizzare i valori.

Sintassi

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

Parametri

hWndOwner

Handle finestra fornita dal chiamante che identifica la finestra in cui devono essere posizionate le nuove pagine del foglio 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 finale della funzione pfnPropSheetUI . Se NULL, lo stato restituito finale non viene restituito. Per ulteriori informazioni, vedere la sezione Osservazioni successiva.

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 ha avuto esito positivo e una finestra di dialogo ha inviato il messaggio di PSM_REBOOTSYSTEM .
CPSUI_RESTARTWINDOWS	L'operazione ha avuto esito positivo e una procedura di dialogo ha inviato il messaggio di PSM_RESTARTWINDOWS .
codice di errore ERR_CPSUI prefisso	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 cpSUI per le applicazioni. Un'applicazione CPSUI (ad esempio lo spooler del sistema operativo basato su Microsoft NT) può chiamare la funzione per aggiungere una o più pagine del foglio delle proprietà a una finestra padre predefinita. CPSUI visualizza le pagine, consente all'utente di modificarli e di notificare l'applicazione dell'attività utente tramite funzioni di callback.

Il sistema operativo basato su NT chiama la funzione CommonPropertySheetUI quando un'applicazione Win32 chiama le funzioni DocumentProperties o PrinterProperties del spooler.

La funzione di callback specificata dal parametro pfnPropSheetUI è responsabile della descrizione delle pagine del foglio delle proprietà da aggiungere. 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 del foglio 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 notifica l'applicazione delle modifiche.

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

Per altre informazioni sulla sequenza di operazione, vedere Uso di CPSUI con driver di stampante, nella sezione denominata CPSUI.

La funzione CommonPropertySheetUI chiama effettivamente il callback pfnPropSheetUI più volte, specificando diversi valori membro Reasonnella struttura PROPSHEETUI_INFO del callback. Ogni volta che il callback restituisce, inserisce lo stato del risultato nel membro Risultato della struttura PROPSHEETUI_INFO. Quando la funzione CommonPropertySheetUI restituisce, 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)