Funzione di callback PFNCOMPROPSHEET (compstui.h)

La funzione ComPropSheet viene fornita da CPSUI e può essere chiamata dalle applicazioni CPSUI (incluse le DLL dell'interfaccia della stampante) per creare pagine delle finestre delle proprietà.

Sintassi

PFNCOMPROPSHEET Pfncompropsheet;

LONG_PTR Pfncompropsheet(
  [in] HANDLE hComPropSheet,
  [in] UINT Function,
  [in] LPARAM lParam1,
  [in] LPARAM lParam2
)
{...}

Parametri

[in] hComPropSheet

Handle fornito dal chiamante a un elemento padre del gruppo della finestra delle proprietà. Per ulteriori informazioni, vedere la sezione Osservazioni successiva.

[in] Function

Codici di funzione ComPropSheet forniti dal chiamante CPSFUNC_ prefissi che specificano l'operazione da eseguire dalla funzione ComPropSheet .

Nota

Vedere la tabella dei codici di funzione ComPropSheet nella sezione Osservazioni di seguito.

[in] lParam1

Valore fornito dal chiamante che dipende dal codice della funzione ComPropSheet fornito per Function.

[in] lParam2

Valore fornito dal chiamante che dipende dal codice della funzione ComPropSheet fornito per Function.

Valore restituito

Il valore restituito dipende dal codice della funzione ComPropSheet fornito per Function.

Commenti

Quando CPSUI chiama una delle funzioni di tipo PFNPROPSHEETUI di un'applicazione, passa un puntatore alla funzione ComPropSheet in una struttura PROPSHEETUI_INFO . Una funzione tipizzata PFNPROPSHEETUI può chiamare la funzione ComPropSheet per descrivere le pagine delle finestre delle proprietà a CPSUI.

Una DLL dell'interfaccia della stampante può chiamare ComPropSheet dalla relativa funzione DrvDocumentPropertySheets o dalla relativa funzione DrvDevicePropertySheets .

I plug-in dell'interfaccia utente per i driver Unidrv e Pscript di Microsoft possono chiamare ComPropSheet dai metodi IPrintOemUI::D ocumentPropertySheets e IPrintOemUI::D evicePropertySheets.

L'handle padre del gruppo specificato per il parametro hComPropSheet può essere uno dei seguenti:

  • Handle ricevuto nel membro hComPropSheet di una struttura PROPSHEETUI_INFO .

  • Handle ricevuto come risultato della chiamata precedente a ComPropSheet con un codice di funzione CPSFUNC_INSERT_PSUIPAGE e specificando PSUIPAGEINSERT_GROUP_PARENT come membro Type per una struttura INSERTPSUIPAGE_INFO .

Codici di funzione ComPropSheet

I codici di funzione seguenti possono essere passati alla funzione ComPropSheet di CPSUI:

CPSFUNC_ADD_HPROPSHEETPAGE

Il codice della funzione CPSFUNC_ADD_HPROPSHEETPAGE fa sì che la funzione ComPropSheet aggiunga una pagina della finestra delle proprietà creata chiamando la funzione CreatePropertySheetPage .

Parametri (CPSFUNC_ADD_HPROPSHEETPAGE)
  • hComPropSheet: handle padre del gruppo

  • Funzione: il chiamante imposta questo parametro di codice della funzione su CPSFUNC_ADD_HPROPSHEETPAGE quando chiama ComPropSheet per aggiungere una pagina della finestra delle proprietà

  • lParam1: Handle in una pagina della finestra delle proprietà, ottenuta chiamando la funzione CreatePropertySheetPage

  • lParam2: non usato, deve essere zero

Valore restituito (CPSFUNC_ADD_HPROPSHEETPAGE)

Se l'operazione ha esito positivo, ComPropSheet restituisce un handle CPSUI alla pagina aggiunta; in caso contrario, restituisce NULL.

CPSFUNC_ADD_PCOMPROPSHEETUI

Il codice della funzione CPSFUNC_ADD_PCOMPROPSHEETUI fa sì che la funzione ComPropSheet aggiunga un set di una o più pagine della finestra delle proprietà descritte da una struttura COMPROPSHEETUI .

Parametri
  • hComPropSheet: handle padre del gruppo

  • Funzione: il chiamante imposta questo parametro di codice della funzione su CPSFUNC_ADD_PCOMPROPSHEETUI quando chiama ComPropSheet per aggiungere un set di una o più pagine della finestra delle proprietà

  • lParam1: Puntatore a una struttura COMPROPSHEETUI

  • lParam2: puntatore a una posizione a 32 bit per ricevere il numero di pagine aggiunte o, in caso di errore, un codice di errore con prefisso ERR_CPSUI

Valore restituito

Se l'operazione ha esito positivo, ComPropSheet restituisce un handle al set di pagine aggiunte; in caso contrario, la funzione restituisce NULL.

CPSFUNC_ADD_PFNPROPSHEETUI

Il codice della funzione CPSFUNC_ADD_PFNPROPSHEETUI fa sì che la funzione ComPropSheet chiami la funzione PFNPROPSHEETUI specificata, che deve aggiungere un set di una o più pagine della finestra delle proprietà.

Parametri (CPSFUNC_ADD_PFNPROPSHEETUI)
  • hComPropSheet: handle padre del gruppo

  • Funzione: il chiamante imposta questo parametro di codice della funzione su CPSFUNC_ADD_PFNPROPSHEETUI quando chiama ComPropSheet. ComPropSheet chiama quindi la funzione tipizzata PFNPROPSHEETUI specificata per aggiungere un set di una o più pagine della finestra delle proprietà.

  • lParam1: Puntatore a una funzione tipizzata PFNPROPSHEETUI

  • lParam2: valore a 32 bit passato alla funzione tipizzata PFNPROPSHEETUI per il parametro lParam

Valore restituito (CPSFUNC_ADD_PFNPROPSHEETUI)

Se l'operazione ha esito positivo, ComPropSheet restituisce un handle al set di pagine aggiunte; in caso contrario, la funzione restituisce NULL.

CPSFUNC_ADD_PROPSHEETPAGE

Il codice della funzione CPSFUNC_ADD_PROPSHEETPAGE fa sì che la funzione ComPropSheet aggiunga il tipo di pagina della finestra delle proprietà descritta da una struttura PROPSHEETPAGE .

Parametri (CPSFUNC_ADD_PROPSHEETPAGE)
  • hComPropSheet: handle padre del gruppo

  • Funzione: il chiamante imposta questo parametro di codice della funzione su CPSFUNC_ADD_PROPSHEETPAGE quando chiama ComPropSheet per aggiungere il tipo di pagina della finestra delle proprietà descritta da una struttura PROPSHEETPAGE . La funzione ComPropSheet chiama la funzione CreatePropertySheetPage e passa l'indirizzo della struttura PROPSHEETPAGE per creare la pagina.

  • lParam1: Puntatore a una struttura PROPSHEETPAGE

  • lParam2: non usato, deve essere zero

Valore restituito (CPSFUNC_ADD_PROPSHEETPAGE)

Se l'operazione ha esito positivo, ComPropSheet restituisce un handle CPSUI alla pagina aggiunta; in caso contrario, restituisce NULL.

CPSFUNC_DELETE_HCOMPROPSHEET

Il codice della funzione CPSFUNC_DELETE_HCOMPROPSHEET fa sì che la funzione ComPropSheet elimini un set di pagine della finestra delle proprietà specificate da un handle CPSUI.

Parametri (CPSFUNC_DELETE_HCOMPROPSHEET)
  • hComPropSheet: handle padre del gruppo

  • Funzione: il chiamante imposta questo parametro di codice della funzione su CPSFUNC_DELETE_HCOMPROPSHEET quando chiama ComPropSheet per eliminare un set di pagine della finestra delle proprietà

  • lParam1: handle CPSUI che fa riferimento al set di pagine da eliminare. Questo handle deve essere stato ottenuto in precedenza da una chiamata a ComPropSheet con uno dei codici di funzione seguenti:

    • CPSFUNC_ADD_HPROPSHEETPAGE

    • CPSFUNC_ADD_PCOMPROPSHEETUI

    • CPSFUNC_ADD_PFNPROPSHEETUI

    • CPSFUNC_ADD_PROPSHEETPAGE

    • CPSFUNC_INSERT_PSUIPAGE

  • lParam2: non usato, deve essere zero

Valore restituito (CPSFUNC_DELETE_HCOMPROPSHEET)

La funzione ComPropSheet restituisce il numero di pagine della finestra delle proprietà eliminate.

CPSFUNC_DO_APPLY_CPSUI

Il codice della funzione CPSFUNC_DO_APPLY_CPSUI fa sì che la funzione ComPropSheet simula il recapito di un messaggio di notifica PSN_APPLY.

CPSUI risponde al codice della funzione CPSFUNC_DO_APPLY_CPSUI recapitando il motivo CPSUICB_REASON_APPLYNOW alla funzione di callback _CPSUICALLBACK tipizzata di un'applicazione.

Parametri (CPSFUNC_DO_APPLY_CPSUI)
  • hComPropSheet: handle padre del gruppo

  • Funzione: il chiamante imposta questo parametro del codice della funzione su CPSFUNC_DO_APPLY_CPSUI quando chiama ComPropSheet per simulare il recapito di un messaggio di notifica PSN_APPLY

  • lParam1: handle CPSUI che punta a un set di una o più pagine della finestra delle proprietà. In genere, questo handle è stato specificato in precedenza come parametro lParam1 in ComPropSheet usando il codice della funzione CPSFUNC_IGNORE_CPSUI_PSN_APPLY .

  • lParam2: questo parametro è una combinazione dei flag di bit seguenti:

    • APPLYCPSUI_NO_NEWDEF: impostare questo flag se non si desidera modificare i valori predefiniti correnti (usati per l'operazione Annulla). Deselezionare questo flag se si desidera che i valori correnti per tutte le opzioni diventino le impostazioni predefinite usate per l'operazione Annulla.

    • APPLYCPSUI_OK_CANCEL_BUTTON : impostare questo flag se l'utente ha selezionato il pulsante OK o Annulla (o se si vuole simulare questa attività). Deselezionare questo flag se l'utente ha selezionato il pulsante Chiudi o Applica ora (o se si vuole simulare questa attività). Se il codice è configurato per ricevere PSN_APPLY messaggi, il codice deve controllare il membro lParam della struttura PSHNOTIFY . Se il membro è zero, questo bit deve essere cancellato.

Valore restituito (CPSFUNC_DO_APPLY_CPSUI)

Se l'operazione ha esito positivo, la funzione ComPropSheet restituisce un valore diverso da zero; in caso contrario, restituisce zero e le pagine specificate diventeranno attive.

Se si usa il codice della funzione CPSFUNC_IGNORE_CPSUI_PSN_APPLY per disabilitare la gestione cpsui del messaggio di notifica PSN_APPLY, è necessario usare il codice della funzione CPSFUNC_DO_APPLY_CPSUI per simulare il recapito del messaggio di PSN_APPLY. In caso contrario, non è possibile ottenere le modifiche apportate all'utente in una pagina della finestra delle proprietà.

CPSFUNC_GET_HPSUIPAGES

Il codice della funzioneCPSFUNC_GET_HPSUIPAGES causa la restituzione di una matrice di handle CPSUI che puntano alle pagine del foglio delle proprietà. Questi handle identificano le pagine figlio associate all'handle padre del gruppo specificato.

Per usare questo codice di funzione, seguire questa procedura:

  • Chiamare ComPropSheet, specificando il codice della funzione CPSFUNC_GET_PAGECOUNT , per ottenere il numero di pagine figlio associate all'elemento padre del gruppo specificato.

  • Allocare memoria locale sufficiente per contenere una struttura HANDLE per ogni pagina.

  • Chiamare di nuovo ComPropSheet , specificando il codice della funzione CPSFUNC_GET_HPSUIPAGES e l'indirizzo della memoria allocata in locale, per ottenere una matrice di strutture HANDLE.

Parametri (CPSFUNC_GET_HPSUIPAGES)
  • hComPropSheet: handle padre del gruppo

  • Funzione: chiama il chiamante imposta questo parametro di codice funzione su CPSFUNC_GET_HPSUIPAGES quando chiama ComPropSheet per recuperare una matrice di handle CPSUI

  • lParam1: Puntatore a una matrice di strutture HANDLE

  • lParam2: dimensioni della matrice HANDLE a cui punta lParam1

Valore restituito (CPSFUNC_GET_HPSUIPAGES)

La funzione ComPropSheet restituisce il numero di handle che CPSUI inserisce nella matrice HANDLE.

CPSFUNC_GET_PAGECOUNT

Il codice della funzione CPSFUNC_GET_PAGECOUNT fa sì che la funzione ComPropSheet restituisca il numero di pagine del foglio delle proprietà che sono pagine figlio dell'handle padre del gruppo specificato.

Parametri (CPSFUNC_GET_PAGECOUNT)
  • hComPropSheet: handle padre del gruppo

  • Funzione: Chiamante imposta questo parametro del codice funzione su CPSFUNC_GET_PAGECOUNT quando chiama ComPropSheet per restituire il conteggio delle pagine figlio

  • lParam1: non usato, deve essere zero

  • lParam2: non usato, deve essere zero

Valore restituito (CPSFUNC_GET_PAGECOUNT)

La funzione ComPropSheet restituisce il numero di pagine conteggiate.

CPSFUNC_GET_PFNPROPSHEETUI_ICON

Il codice della funzioneCPSFUNC_GET_PFNPROPSHEETUI_ICON causa la restituzione di un handle all'icona associata a un set di pagine del foglio delle proprietà. Il set di pagine deve essere stato creato in precedenza da una funzione tipizzata PFNPROPSHEETUI.

La funzione ComPropSheet chiama la funzione tipizzata PFNPROPSHEETUI associata all'handle di pagina specificato e passa un valore motivo di PROPSHEETUI_REASON_GET_ICON. La funzione PFNPROPSHEETUI-typed chiama quindi LoadImage e fornisce le dimensioni dell'icona specificate dalParam2 per caricare una risorsa icona.

Parametri (CPSFUNC_GET_PFNPROPSHEETUI_ICON)
  • hComPropSheet: handle padre del gruppo

  • Funzione: Chiamante imposta questo parametro di codice funzione su CPSFUNC_GET_PFNPROPSHEETUI_ICON quando chiama ComPropSheet per recuperare un handle all'icona associata a un set di pagine del foglio delle proprietà

  • lParam1: handle CPSUI che fa riferimento a un set di pagine del foglio delle proprietà. Questo handle deve essere stato ottenuto in precedenza da una chiamata a ComPropSheet con il codice della funzione CPSFUNC_ADD_PFNPROPSHEETUI .

  • lParam2: specifica due valori di dimensioni WORD che rappresentano le dimensioni dell'icona, in pixel. Il valore LOWORD è la larghezza e il valore HIWORD è l'altezza. Se questi valori sono zero, vengono usate le metriche di sistema SM_CXICON e SM_CYICON. Per altre informazioni, vedere GetSystemMetrics.

Valore restituito (CPSFUNC_GET_PFNPROPSHEETUI_ICON)

Se l'operazione ha esito positivo, la funzione ComPropSheet restituisce un handle icona; in caso contrario, restituisce NULL.

CPSFUNC_IGNORE_CPSUI_PSN_APPLY

Il codice della funzione CPSFUNC_IGNORE_CPSUI_PSN_APPLY causa la disabilitazione o la PSN_APPLY gestione di CPSUI della funzione ComPropSheet.

Il sistema invia il messaggio di notifica PSN_APPLY a CPSUI quando un utente seleziona il pulsante OK o Annulla del foglio delle proprietà. CPSUI risponde a questo messaggio recapitando il motivo CPSUICB_REASON_APPLYNOW alla funzione di callback _CPSUICALLBACK tipizzata di un'applicazione.

Se si disabilita la gestione di CPSUI del messaggio di notifica PSN_APPLY, è necessario usare il codice della funzione CPSFUNC_DO_APPLY_CPSUI per simulare il recapito del messaggio di PSN_APPLY. In caso contrario, non è possibile ottenere le modifiche dell'utente a una pagina del foglio delle proprietà.

Se il codice della funzione CPSFUNC_IGNORE_CPSUI_PSN_APPLY non viene usato, la gestione del messaggio di notifica di PSN_APPLY cpSUI è abilitata per impostazione predefinita.

Parametri (CPSFUNC_IGNORE_CPSUI_PSN_APPLY)
  • hComPropSheet: handle padre del gruppo

  • Funzione: Chiamante imposta questo parametro del codice di funzione su CPSFUNC_IGNORE_CPSUI_PSN_APPLY quando chiama ComPropSheet per disabilitare o riabilitare la gestione del messaggio di notifica di PSN_APPLY

  • lParam1: handle CPSUI che fa riferimento a un set di pagine del foglio delle proprietà o più. Questo handle deve essere stato ottenuto in precedenza da una chiamata a ComPropSheet con un codice di funzione di CPSFUNC_ADD_PCOMPROPSHEETUI o con un codice di funzione di CPSFUNC_INSERT_PSUIPAGE e un tipo di inserimento di PSUIPAGEINSERT_PROPSHEETPAGE.

  • lParam2: qualsiasi valore diverso da zero disabilita il recapito di CPSUI del motivo CPSUICB_REASON_APPLYNOW. Un valore zero reenables recapito del CPSUICB_REASON_APPLYNOW motivo.

Valore restituito (CPSFUNC_IGNORE_CPSUI_PSN_APPLY)

Se l'operazione ha esito positivo, la funzione ComPropSheet restituisce un valore diverso da zero; in caso contrario, restituisce zero.

CPSFUNC_INSERT_PSUIPAGE

Il codice della funzioneCPSFUNC_INSERT_PSUIPAGE causa l'inserimento di un set di pagine del foglio di proprietà in una posizione specifica.

Parametri (CPSFUNC_INSERT_PSUIPAGE)
  • hComPropSheet: handle padre del gruppo

  • Funzione: Chiamante imposta questo parametro di codice funzione su CPSFUNC_INSERT_PSUIPAGE quando chiama ComPropSheet per inserire un set di pagine del foglio di proprietà in una posizione specifica

  • lParam1: specifica un handle in un set di pagine di una o più pagine del foglio delle proprietà. Le nuove pagine verranno inserite prima o dopo queste pagine, a seconda del membro modalità della struttura INSERTPSUIPAGE_INFO a cui punta lParam2. Questo handle deve essere stato ottenuto in precedenza da una chiamata a ComPropSheet con uno dei codici di funzione seguenti:

    • CPSFUNC_ADD_HPROPSHEETPAGE

    • CPSFUNC_ADD_PCOMPROPSHEETUI

    • CPSFUNC_ADD_PFNPROPSHEETUI

    • CPSFUNC_ADD_PROPSHEETPAGE

    • CPSFUNC_INSERT_PSUIPAGE

  • lParam2: puntatore a una struttura INSERTPSUIPAGE_INFO , che descrive dove e come inserire le nuove pagine

Valore restituito (CPSFUNC_INSERT_PSUIPAGE)

Se l'operazione ha esito positivo, la funzione ComPropSheet restituisce un handle al set di pagine inserite; in caso contrario, la funzione restituisce NULL.

CPSFUNC_LOAD_CPSUI_ICON

Il codice della funzione CPSFUNC_LOAD_CPSUI_ICON causa il caricamento di una risorsa icona fornita da CPSUI dalla funzione ComPropSheet .

CPSUI chiama LoadImage per caricare la risorsa icona specificata.

Parametri (CPSFUNC_LOAD_CPSUI_ICON)
  • hComPropSheet: handle padre del gruppo

  • Funzione: Chiamante imposta questo parametro di codice funzione su CPSFUNC_LOAD_CPSUI_ICON quando chiama ComPropSheet per caricare una risorsa dell'icona fornita da CPSUI

  • lParam1: identificatore della risorsa dell'icona fornita da CPSUI da caricare. Questo deve essere un identificatore con prefisso IDI_CPSUI definito in Compstui.h.

  • lParam2: specifica due valori di dimensioni WORD che rappresentano le dimensioni dell'icona, in pixel. Il valore LOWORD è la larghezza e il valore HIWORD è l'altezza. Se questi valori sono zero, vengono usate le metriche di sistema SM_CXICON e SM_CYICON. Per altre informazioni, vedere GetSystemMetrics

Valore restituito (CPSFUNC_LOAD_CPSUI_ICON)

Se l'operazione ha esito positivo, la funzione ComPropSheet restituisce un handle icona; in caso contrario, restituisce NULL.

CPSFUNC_LOAD_CPSUI_STRING

Il codice della funzione CPSFUNC_LOAD_CPSUI_STRING causa il caricamento di una risorsa stringa fornita da CPSUI dalla funzione ComPropSheet .

La funzione ComPropSheet chiama la funzione LoadString](/windows/win32/api/winuser/nf-winuser-loadstringw) per caricare la stringa specificata.

Parametri (CPSFUNC_LOAD_CPSUI_STRING)
  • hComPropSheet: handle padre del gruppo

  • Funzione: Chiamante imposta questo parametro del codice di funzione su CPSFUNC_LOAD_CPSUI_STRING quando chiama ComPropSheet per caricare una risorsa stringa fornita da CPSUI

  • lParam1: un puntatore tipizzato LPSTR a un buffer allocato dal chiamante, in cui verrà inserita la stringa fornita da CPSUI specificata da HIWORD(lParam2)

  • lParam2: contiene i due valori forniti dal chiamante seguenti:

    • LOWORD(lParam2). Dimensioni, in byte, del buffer a cui punta lParam1.

    • HIWORD(lParam2). Identificatore di risorsa della stringa fornita da CPSUI da caricare. Deve essere un identificatore con prefisso IDS_CPSUI definito in Compstui.h.

Valore restituito (CPSFUNC_LOAD_CPSUI_STRING)

Se l'operazione ha esito positivo, la funzione ComPropSheet restituisce la lunghezza della stringa. Se viene specificato un identificatore di risorsa non valido, la funzione restituisce zero. Se lParam1 è NULL o LOWORD(lParam2) è zero, la funzione restituisce -1.

CPSFUNC_QUERY_DATABLOCK

Il codice della funzione CPSFUNC_QUERY_DATABLOCK fa sì che la funzione ComPropSheet recupera un blocco di dati fornito dal chiamante archiviato in precedenza usando il codice della funzione CPSFUNC_SET_DATABLOCK .

In genere, questo codice di funzione viene usato da una funzione di callback tipizzata _CPSUICALLBACK (quando la struttura CPSUICBPARAM della funzione contiene un valore Reason di CPSUICB_REASON_SETACTIVE) per recuperare i valori associati a un'altra pagina prima che la pagina corrente diventi inattiva.

Parametri (CPSFUNC_QUERY_DATABLOCK)
  • hComPropSheet: handle padre del gruppo

  • Funzione: Chiamante imposta questo parametro di codice funzione su CPSFUNC_QUERY_DATABLOCK quando chiama ComPropSheet per recuperare un blocco di dati fornito dal chiamante

  • lParam1: Puntatore a una struttura CPSUIDATABLOCK che identifica le dimensioni e la posizione di un buffer per ricevere il blocco dati richiesto

  • lParam2: valore identificatore di dimensioni DWORD, usato per identificare la struttura CPSUIDATABLOCK richiesta. Questo valore deve essere stato specificato in una chiamata precedente a ComPropSheet usando il codice della funzione CPSFUNC_SET_DATABLOCK .

Valore restituito (CPSFUNC_QUERY_DATABLOCK)

Se l'operazione ha esito positivo, la funzione ComPropSheet restituisce un valore che rappresenta le dimensioni del blocco di dati recuperato. Se lParam1 è NULL o se il valore di qualsiasi membro della struttura CPSUIDATABLOCK specificato è zero, ComPropSheet restituisce le dimensioni necessarie per archiviare il blocco dati. Se si verifica un errore, la funzione restituisce un valore minore o uguale a zero.

CPSFUNC_SET_DATABLOCK

Il codice della funzione CPSFUNC_SET_DATABLOCK causa l'archiviazione di un blocco di dati fornito dal chiamante ComPropSheet . È possibile usare questo codice di funzione per rendere disponibili le informazioni su una pagina del foglio delle proprietà per altre pagine.

In genere, questo codice di funzione viene usato da una funzione di callback tipizzata _CPSUICALLBACK (quando la struttura CPSUICBPARAM della funzione contiene un valore Reason di CPSUICB_REASON_KILLACTIVE) per salvare i valori associati a una pagina prima che diventi inattivo.

Parametri (CPSFUNC_SET_DATABLOCK)
  • hComPropSheet: handle padre del gruppo

  • Funzione: Chiamante imposta questo parametro di codice funzione su CPSFUNC_SET_DATABLOCK quando chiama ComPropSheet per archiviare un blocco di dati fornito dal chiamante

  • lParam1: Puntatore a una struttura CPSUIDATABLOCK che descrive il blocco di dati da archiviare

  • lParam2: valore identificatore DWORD definito dal chiamante. Viene usato per identificare la struttura CPSUIDATABLOCK fornita nelle chiamate successive a ComPropSheet usando il codice della funzione CPSFUNC_QUERY_DATABLOCK .

Valore restituito (CPSFUNC_SET_DATABLOCK)

Se l'operazione ha esito positivo, la funzione ComPropSheet restituisce un valore che rappresenta il numero di byte archiviati; in caso contrario, restituisce un valore minore o uguale a zero.

CPSFUNC_SET_DMPUB_HIDEBITS

Il codice della funzione CPSFUNC_SET_DMPUB_HIDEBITS causa la "nascondi" della funzione ComPropSheet in un set specificato di opzioni di proprietà documento, in modo che non vengano visualizzate.

È possibile usare il codice della funzione CPSFUNC_SET_DMPUB_HIDEBITS se si desidera definire le strutture OPTITEM per una o più opzioni del foglio delle proprietà del documento, ma non si vuole che le opzioni siano modificabili dall'utente. La pagina del foglio delle proprietà deve essere definita usando la struttura COMPROPSHEETUI e il membro pDlgPage della struttura deve essere CPSUI_PDLGPAGE_DOCPROP o CPSUI_PDLGPAGE_ADVDOCPROP.

Se si usa il codice della funzione CPSFUNC_SET_DMPUB_HIDEBITS, deve essere specificato in ComPropSheet prima che il codice della funzione CPSFUNC_ADD_PCOMPROPSHEETUI o CPSFUNC_INSERT_PSUIPAGE venga usato per creare la pagina.

Parametri (CPSFUNC_SET_DMPUB_HIDEBITS)
  • hComPropSheet: handle padre del gruppo

  • Funzione: Chiamante imposta questo parametro del codice di funzione su CPSFUNC_SET_DMPUB_HIDEBITS quando chiama ComPropSheet per "nascondere" un set specificato di opzioni di proprietà documento

  • lParam1: puntatore a una matrice di bit che indica le opzioni da nascondere. Questa matrice deve essere creata usando la macro MAKE_DMPUB_HIDEBIT(DMPub), dove DMPub è la combinazione OR di una o più costanti con prefisso DMPUB_. Le costanti DMPUB_ con prefisso sono elencate nella descrizione della struttura OPTITEM . Le macro e le costanti sono definite in Compstui.h.

  • lParam2: non usato, deve essere zero

Valore restituito (CPSFUNC_SET_DMPUB_HIDEBITS)

Se l'operazione ha esito positivo, la funzione ComPropSheet restituisce il valore specificato per lParam1; in caso contrario, restituisce zero.

CPSFUNC_SET_FUSION_CONTEXT

Il CPSFUNC_SET_FUSION_CONTEXT imposta un contesto di attivazione Fusion per la pagina specificata.

Quando una pagina sta per essere creata o inserita e non specifica un contesto di attivazione nella struttura PROPSHEETPAGE , verrà creata nel contesto di attivazione della pagina padre.

Se il contesto di attivazione dell'elemento padre non è impostato, Compstui.dll cerca l'elemento padre dell'elemento padre, continuando fino a quando non viene raggiunto o fino a quando non trova un elemento padre con un contesto di attivazione impostato correttamente.

Se nessuno dei genitori ha un set di contesto di attivazione, Compstui.dll non specifica un contesto di attivazione nella struttura PROPSHEETPAGE . Ciò significa che la pagina verrà creata nel contesto di attivazione del chiamante della funzione PropertySheet .

Parametri (CPSFUNC_SET_FUSION_CONTEXT)
  • hComPropSheet: handle padre del gruppo

  • Funzione: Chiamante imposta questo parametro del codice di funzione su CPSFUNC_SET_FUSION_CONTEXT quando chiama ComPropSheet per impostare un contesto di attivazione Fusion per la pagina specificata

  • lParam1: specifica l'handle nel contesto Fusion. Compstui.dll duplica l'handle, associandolo alle strutture interne, in modo che il chiamante non sia obbligato a mantenere l'handle. Compstui.dll rilascia l'handle di contesto passato quando l'handle Compstui.dll viene eliminato.

  • lParam2: non usato, deve essere zero

Valore restituito (CPSFUNC_SET_FUSION_CONTEXT)

Se l'operazione ha esito positivo, la funzione ComPropSheet restituisce un valore maggiore di zero. In caso contrario, ComPropSheet restituisce un valore minore o uguale a zero. Per informazioni sull'errore, usare la funzione GetLastError .

CPSFUNC_SET_HSTARTPAGE

Il codice della funzione CPSFUNC_SET_HSTARTPAGE fa sì che la funzione ComPropSheet contrassegni una pagina del foglio delle proprietà specificata sia la pagina superiore del foglio delle proprietà associato. Se il foglio delle proprietà è attualmente visualizzato, la pagina specificata diventa la pagina attiva.

Parametri (CPSFUNC_SET_HSTARTPAGE)
  • hComPropSheet: handle padre del gruppo

  • Funzione: Chiamante imposta questo parametro del codice di funzione su CPSFUNC_SET_HSTARTPAGE quando chiama ComPropSheet per contrassegnare una pagina del foglio delle proprietà specificata per essere la pagina superiore del foglio delle proprietà associato

  • lParam1: Handle di pagina CPSUI fornito dal chiamante, ottenuto in precedenza da una chiamata a ComPropSheet con uno dei codici di funzione seguenti:

    • CPSFUNC_ADD_HPROPSHEETPAGE

    • CPSFUNC_ADD_PCOMPROPSHEETUI

    • CPSFUNC_ADD_PFNPROPSHEETUI

    • CPSFUNC_ADD_PROPSHEETPAGE

    • CPSFUNC_INSERT_PSUIPAGE

    Se l'handle rappresenta una singola pagina appartenente al gruppo specificato da hComPropSheet, CPSUI rende la pagina superiore.

    Se l'handle rappresenta un handle padre del gruppo (vedere CPSFUNC_INSERT_PSUIPAGE), lParam2 rappresenta un indice in base zero nelle pagine del gruppo e la pagina rappresentata dall'indice diventa la pagina superiore.

  • lParam2: se lParam1 rappresenta un handle padre del gruppo, questo valore fornito dal chiamante è un indice in base zero nelle pagine del gruppo. Se lParam1 rappresenta una singola pagina appartenente al gruppo specificato da hComPropSheet, questo parametro non viene usato. Se l'handle specificato da lParam1 è stato ottenuto usando il codice della funzione CPSFUNC_ADD_PCOMPROPSHEETUI e se il membro pDlgPage della struttura COMPROPSHEETUI associata è stato impostato su CPSUI_PDLGPAGE_DOCPROP, è possibile specificare uno dei valori seguenti per lParam2:

    • SSP_STDPAGE1 : creare la pagina superiore del layout.

    • SSP_STDPAGE2 : creare la pagina superiore carta/qualità.

    • SSP_TVPAGE : impostare la pagina superiore della pagina Avanzate.

Valore restituito (CPSFUNC_SET_HSTARTPAGE)

Se l'operazione ha esito positivo, la funzione ComPropSheet restituisce il valore specificato per lParam1; in caso contrario, restituisce zero.

CPSFUNC_SET_PSUIPAGE_ICON

Il codice della funzioneCPSFUNC_SET_PSUIPAGE_ICON causa l'aggiunta, la sostituzione o la rimozione dell'icona assegnata alla scheda di una pagina del foglio delle proprietà.

Se lParam2 contiene un handle icona e se la pagina specificata da lParam1 è attualmente visualizzata, CPSUI aggiunge l'icona alla scheda della pagina specificata. Se un'icona è già assegnata alla pagina, l'icona precedente viene sostituita con quella nuova. Se lParam2 è zero, l'icona corrente (se presente) viene rimossa.

Per tutte le icone specificate con il codice della funzione CPSFUNC_SET_PSUIPAGE_ICON , CPSUI imposta le dimensioni dell'immagine su 16 per 16 pixel.

Gli handle dell'icona devono essere ottenuti chiamando LoadImage.

Parametri (CPSFUNC_SET_PSUIPAGE_ICON)
  • hComPropSheet: handle padre del gruppo

  • Funzione: Chiamante imposta questo parametro di codice funzione su CPSFUNC_SET_PSUIPAGE_ICON quando chiama ComPropSheet per aggiungere, sostituire o rimuovere l'icona assegnata alla scheda di una pagina del foglio delle proprietà

  • lParam1: Handle di pagina CPSUI fornito dal chiamante, ottenuto in precedenza da una chiamata a ComPropSheet con uno dei codici di funzione seguenti:

    • CPSFUNC_ADD_HPROPSHEETPAGE

    • CPSFUNC_ADD_PROPSHEETPAGE

    • CPSFUNC_INSERT_PSUIPAGE (con il membro Type della struttura INSERTPSUIPAGE_INFO impostata su PSUIPAGEINSERT_HPROPSHEETPAGE o PSUIPAGEINSERT_PROPSHEETPAGE)

  • lParam2: handle dell'icona fornita dal chiamante. È possibile impostare questo parametro su zero per rimuovere l'icona corrente

Valore restituito (CPSFUNC_SET_PSUIPAGE_ICON)

Se l'operazione ha esito positivo, la funzione ComPropSheet restituisce 1. Se viene rilevato un errore o se la pagina specificata non è attualmente visualizzata, la funzione restituisce zero.

CPSFUNC_SET_PSUIPAGE_TITLE

Il codice della funzione CPSFUNC_SET_PSUIPAGE_TITLE fa sì che la funzione ComPropSheet imposta il titolo della scheda per una pagina del foglio delle proprietà.

Parametri (CPSFUNC_SET_PSUIPAGE_TITLE)
  • hComPropSheet: handle padre del gruppo

  • Funzione: il chiamante imposta questo parametro di codice della funzione su CPSFUNC_SET_PSUIPAGE_TITLE quando chiama ComPropSheet per impostare il titolo della scheda per una pagina della finestra delle proprietà

  • lParam1: handle di pagina CPSUI fornito dal chiamante, precedentemente ottenuto da una chiamata a ComPropSheet con uno dei codici di funzione seguenti:

    • CPSFUNC_ADD_HPROPSHEETPAGE

    • CPSFUNC_ADD_PROPSHEETPAGE

    • CPSFUNC_INSERT_PSUIPAGE (con il membro Type della struttura INSERTPSUIPAGE_INFO impostata su PSUIPAGEINSERT_HPROPSHEETPAGE o PSUIPAGEINSERT_PROPSHEETPAGE).

  • lParam2: puntatore fornito dal chiamante a una stringa con terminazione NULL che specifica il nuovo titolo

Valore restituito (CPSFUNC_SET_PSUIPAGE_TITLE)

Se l'operazione ha esito positivo, la funzione ComPropSheet restituisce 1. Se si verifica un errore o se la pagina specificata non è attualmente visualizzata, la funzione restituisce zero.

CPSFUNC_SET_RESULT

Il codice della funzione CPSFUNC_SET_RESULT fa sì che la funzione ComPropSheet passi un valore di risultato specificato a tutte le funzioni tipate PFNPROPSHEETUI associate a una pagina specificata e ai relativi elementi padre.

Per altre informazioni su come impostare i valori dei risultati, vedere la descrizione della struttura SETRESULT_INFO .

La cautela seguente si applica al plug-in IHV basato su Unidrv- o Pscript5 con le finestre delle proprietà dell'interfaccia utente personalizzate e per cui le impostazioni utente effettuate nelle finestre delle proprietà devono essere persistenti. Quando il plug-in chiama la funzione ComPropSheet con il parametro Function impostato su CPSFUNC_SET_RESULT, il plug-in deve impostare il parametro lParam2 su CPSUI_OK.

Parametri (CPSFUNC_SET_RESULT)
  • hComPropSheet: handle padre del gruppo

  • Funzione: il chiamante imposta questo parametro di codice della funzione su CPSFUNC_SET_RESULT quando chiama ComPropSheet per passare un valore di risultato specificato a tutte le funzioni tipate PFNPROPSHEETUI associate a una pagina specificata e ai relativi elementi padre.

  • lParam1: handle CPSUI fornito dal chiamante alla pagina per cui viene passato un valore di risultato. Se lParam1 è NULL, il CPSUI utilizza il valore specificato da hComPropSheet.

  • lParam2: valore del risultato DWORD fornito dal chiamante a 32 bit.

Valore restituito (CPSFUNC_SET_RESULT)

Se l'operazione ha esito positivo, la funzione ComPropSheet restituisce il numero di funzioni tipate PFNPROPSHEETUI chiamate. Se l'handle specificato per lParam1 non è valido, la funzione restituisce -1.

Requisiti

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