Función CommonPropertySheetUIA (compstui.h)

La función CommonPropertySheetUI de CPSUI muestra páginas de hojas de propiedades y permite que los usuarios modifiquen 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 hojas de propiedades.

pfnPropSheetUI

Puntero proporcionado por el autor de la llamada a una función de devolución de llamada PFNPROPSHEETUIcon tipo.

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 devuelto final de la función pfnPropSheetUI. Si null, no se devuelve el estado de retorno final. Para obtener más información, vea la siguiente sección Comentarios.

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.
ERR_CPSUI código de error con prefijo	Error. Los códigos de error ERR_CPSUI prefijo se definen en compstui.h.

Observaciones

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 de DocumentProperties o PrinterProperties.

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 PFNPROPSHEETUI.

La secuencia de operación es la siguiente:

1. La función CommonPropertySheetUI llama a la pfnPropSheetUI devolución de llamada para que la devolución de llamada pueda describir las páginas que se van a agregar mediante una llamada a la función ComPropSheet de CPSUI.

2. Si la pfnPropSheetUI devolución de llamada se realiza correctamente, la función CommonPropertySheetUI muestra las nuevas páginas de hojas de propiedades y permite al usuario modificar los valores de página.

3. 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.

4. Cuando el usuario elige la Aceptar o botón Cancelar, la función CommonPropertySheetUI destruye las páginas mostradas y devuelve.

Para obtener más información sobre la secuencia de operación, vea Uso de CPSUI con controladores de impresora, en la sección titulada CPSUI.

La función CommonPropertySheetUI llama realmente a la pfnPropSheetUI devolución de llamada varias veces, especificando valores de miembro Reason diferentes en la estructura 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 de PROPSHEETUI_INFO estructura Result. Cuando se devuelve la función CommonPropertySheetUI, copia el contenido final de Result en la ubicación a la que apunta pResult.

Requisitos

Requisito	Valor
de la plataforma de destino de	Escritorio
encabezado de	compstui.h (include Compstui.h)