Función CommonPropertySheetUIA (compstui.h)
La función CommonPropertySheetUI de CPSUI muestra páginas de hojas de propiedades y permite que el usuario modifique los valores mostrados.
Sintaxis
LONG CommonPropertySheetUIA(
HWND hWndOwner,
PFNPROPSHEETUI pfnPropSheetUI,
LPARAM lParam,
LPDWORD pResult
);
Parámetros
hWndOwner
Identificador de ventana proporcionado por el autor de la llamada que identifica la ventana en la que se van a colocar nuevas páginas de hoja de propiedades.
pfnPropSheetUI
Puntero proporcionado por el autor de la llamada a una función de devolución de llamada con tipo PFNPROPSHEETUI.
lParam
Valor proporcionado por el autor de la llamada que se usa como argumento de entrada para la función pfnPropSheetUI . Este valor puede ser un puntero.
pResult
Puntero proporcionado por el autor de la llamada a un DWORD que recibe el estado de retorno final de la función pfnPropSheetUI . Si es NULL, no se devuelve el estado de devolución final. Para obtener más información, vea la sección Comentarios que se muestra más adelante.
Valor devuelto
La función CommonPropertySheetUI devuelve uno de los siguientes valores:
| Código devuelto | Descripción |
|---|---|
| CPSUI_CANCEL | La función pfnPropSheetUI devolvió un valor negativo. |
| CPSUI_OK | La operación se realizó correctamente. |
| CPSUI_REBOOTSYSTEM | La operación se realizó correctamente y un procedimiento de cuadro de diálogo envió el mensaje PSM_REBOOTSYSTEM . |
| CPSUI_RESTARTWINDOWS | La operación se realizó correctamente y un procedimiento de cuadro de diálogo envió el mensaje PSM_RESTARTWINDOWS . |
| código de error ERR_CPSUI prefijo | Error. Los códigos de error con prefijo ERR_CPSUI se definen en compstui.h. |
Comentarios
La función CommonPropertySheetUI es el punto de entrada de CPSUI para las aplicaciones. Una aplicación CPSUI (como la cola de impresión del sistema operativo basado en Microsoft NT) puede llamar a la función para agregar una o varias páginas de hoja de propiedades a una ventana primaria predefinida. CPSUI muestra las páginas, permite al usuario modificarlas y notifica a la aplicación de la actividad del usuario a través de funciones de devolución de llamada.
El administrador de impresión del sistema operativo basado en NT llama a la función CommonPropertySheetUI cuando una aplicación Win32 llama a las funciones DocumentProperties o PrinterProperties del administrador de colas.
La función de devolución de llamada especificada por el parámetro pfnPropSheetUI es responsable de describir las páginas de la hoja de propiedades que se van a agregar. Para obtener más información, vea la descripción del tipo de función PFNPROPSHEETUI .
La secuencia de operación es la siguiente:
La función CommonPropertySheetUI llama a la devolución de llamada pfnPropSheetUI para que la devolución de llamada pueda describir las páginas que se van a agregar llamando a la función ComPropSheet de CPSUI.
Si la devolución de llamada pfnPropSheetUI se realiza correctamente, la función CommonPropertySheetUI muestra las nuevas páginas de hoja de propiedades y permite al usuario modificar los valores de página.
Si el usuario modifica los valores de página, una devolución de llamada de evento de página notifica a la aplicación de los cambios.
Cuando el usuario elige el botón Aceptar o Cancelar , la función CommonPropertySheetUI destruye las páginas mostradas y devuelve.
Para obtener más información sobre la secuencia de operación, consulte Uso de CPSUI con controladores de impresora, en la sección titulada CPSUI.
La función CommonPropertySheetUI llama realmente a la devolución de llamada pfnPropSheetUI varias veces, especificando diferentes valores de miembro Reason en la estructura de PROPSHEETUI_INFO de la devolución de llamada. Cada vez que se devuelve la devolución de llamada, coloca un estado de resultado en el miembro Result de la estructura PROPSHEETUI_INFO. Cuando se devuelve la función CommonPropertySheetUI, copia el contenido final de Result en la ubicación a la que apunta pResult.
Requisitos
| Requisito | Value |
|---|---|
| Plataforma de destino | Escritorio |
| Encabezado | compstui.h (incluir Compstui.h) |