Función de devolución de llamada PFNCOMPROPSHEET (compstui.h)

CpSUI proporciona la función ComPropSheet y las aplicaciones CPSUI pueden llamar a ella (incluidos los archivos DLL de interfaz de impresora) para crear páginas de hoja de propiedades.

Sintaxis

PFNCOMPROPSHEET Pfncompropsheet;

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

Parámetros

[in] hComPropSheet

Identificador proporcionado por el autor de la llamada a un elemento primario del grupo de hojas de propiedades. Para obtener más información, vea la sección Comentarios que se muestra más adelante.

[in] Function

Códigos de función ComPropSheet proporcionados por el autor de la llamada CPSFUNC_ prefijos que especifican la operación que debe realizar la función ComPropSheet . Consulte la tabla Códigos de función ComPropSheet en la sección Comentarios a continuación.

[in] lParam1

Valor proporcionado por el autor de la llamada que depende del código de función ComPropSheet proporcionado para Function.

[in] lParam2

Valor proporcionado por el autor de la llamada que depende del código de función ComPropSheet proporcionado para Function.

Valor devuelto

El valor devuelto depende del código de función ComPropSheet proporcionado para Function.

Comentarios

Cuando CPSUI llama a una de las funciones de tipo PFNPROPSHEETUI de una aplicación, pasa un puntero a la función ComPropSheet en una estructura de PROPSHEETUI_INFO . Una función con tipo PFNPROPSHEETUI puede llamar a la función ComPropSheet para describir las páginas de la hoja de propiedades a CPSUI.

Un archivo DLL de interfaz de impresora puede llamar a ComPropSheet desde su función DrvDocumentPropertySheets o su función DrvDevicePropertySheets .

Los complementos de interfaz de usuario para los controladores Unidrv y Pscript de Microsoft pueden llamar a ComPropSheet desde sus métodos IPrintOemUI::D ocumentPropertySheets e IPrintOemUI::D evicePropertySheets .

El identificador primario del grupo especificado para el parámetro hComPropSheet puede ser cualquiera de los siguientes:

• Identificador recibido en el miembro hComPropSheet de una estructura de PROPSHEETUI_INFO .

• El identificador recibido como resultado de llamar previamente a ComPropSheet con un código de función de CPSFUNC_INSERT_PSUIPAGE y especificar PSUIPAGEINSERT_GROUP_PARENT como miembro Type para una estructura de INSERTPSUIPAGE_INFO .

Códigos de función ComPropSheet

Los siguientes códigos de función se pueden pasar a la función ComPropSheet de CPSUI:

CPSFUNC_ADD_HPROPSHEETPAGE

El código de función CPSFUNC_ADD_HPROPSHEETPAGE hace que la función ComPropSheet agregue una página de hoja de propiedades creada mediante una llamada a la función CreatePropertySheetPage .

Parámetros (CPSFUNC_ADD_HPROPSHEETPAGE)

• hComPropSheet: identificador primario del grupo

• Función: el llamador establece este parámetro de código de función en CPSFUNC_ADD_HPROPSHEETPAGE cuando llama a ComPropSheet para agregar una página de hoja de propiedades

• lParam1: Identificador de una página de hoja de propiedades, obtenida mediante una llamada a la función CreatePropertySheetPage

• lParam2: No se usa, debe ser cero

Valor devuelto (CPSFUNC_ADD_HPROPSHEETPAGE)

Si la operación se realiza correctamente, ComPropSheet devuelve un identificador CPSUI a la página agregada; de lo contrario, devuelve NULL.

CPSFUNC_ADD_PCOMPROPSHEETUI

El código de función CPSFUNC_ADD_PCOMPROPSHEETUI hace que la función ComPropSheet agregue un conjunto de una o varias páginas de hoja de propiedades que se describen mediante una estructura COMPROPSHEETUI .

Parámetros

• hComPropSheet: identificador primario del grupo

• Función: el llamador establece este parámetro de código de función en CPSFUNC_ADD_PCOMPROPSHEETUI cuando llama a ComPropSheet para agregar un conjunto de una o varias páginas de hoja de propiedades

• lParam1: puntero a una estructura COMPROPSHEETUI

• lParam2: puntero a una ubicación de 32 bits para recibir el número de páginas agregadas o, si se produce un error, un código de error con prefijo ERR_CPSUI

Valor devuelto

Si la operación se realiza correctamente, ComPropSheet devuelve un identificador al conjunto de páginas agregadas; de lo contrario, la función devuelve NULL.

CPSFUNC_ADD_PFNPROPSHEETUI

El código de función CPSFUNC_ADD_PFNPROPSHEETUI hace que la función ComPropSheet llame a la función con tipo PFNPROPSHEETUI especificada, que debe agregar un conjunto de una o varias páginas de hoja de propiedades.

Parámetros (CPSFUNC_ADD_PFNPROPSHEETUI)

• hComPropSheet: identificador primario del grupo

• Función: el llamador establece este parámetro de código de función en CPSFUNC_ADD_PFNPROPSHEETUI cuando llama a ComPropSheet. A continuación, ComPropSheet llama a la función de tipo PFNPROPSHEETUI especificada para agregar un conjunto de una o varias páginas de hoja de propiedades.

• lParam1: puntero a una función con tipo PFNPROPSHEETUI

• lParam2: valor de 32 bits que se pasa a la función con tipo PFNPROPSHEETUI para su parámetro lParam.

Valor devuelto (CPSFUNC_ADD_PFNPROPSHEETUI)

Si la operación se realiza correctamente, ComPropSheet devuelve un identificador al conjunto de páginas agregadas; de lo contrario, la función devuelve NULL.

CPSFUNC_ADD_PROPSHEETPAGE

El código de función CPSFUNC_ADD_PROPSHEETPAGE hace que la función ComPropSheet agregue el tipo de página de hoja de propiedades que se describe mediante una estructura PROPSHEETPAGE .

Parámetros (CPSFUNC_ADD_PROPSHEETPAGE)

• hComPropSheet: identificador primario del grupo

• Función: el llamador establece este parámetro de código de función en CPSFUNC_ADD_PROPSHEETPAGE cuando llama a ComPropSheet para agregar el tipo de página de hoja de propiedades descrita por una estructura PROPSHEETPAGE . La función ComPropSheet llama a la función CreatePropertySheetPage y pasa la dirección de la estructura PROPSHEETPAGE para crear la página.

• lParam1: puntero a una estructura PROPSHEETPAGE

• lParam2: No se usa, debe ser cero

Valor devuelto (CPSFUNC_ADD_PROPSHEETPAGE)

Si la operación se realiza correctamente, ComPropSheet devuelve un identificador CPSUI a la página agregada; de lo contrario, devuelve NULL.

CPSFUNC_DELETE_HCOMPROPSHEET

El código de función CPSFUNC_DELETE_HCOMPROPSHEET hace que la función ComPropSheet elimine un conjunto de páginas de hoja de propiedades especificadas por un identificador CPSUI.

Parámetros (CPSFUNC_DELETE_HCOMPROPSHEET)

• hComPropSheet: identificador primario del grupo

• Función: el llamador establece este parámetro de código de función en CPSFUNC_DELETE_HCOMPROPSHEET cuando llama a ComPropSheet para eliminar un conjunto de páginas de hoja de propiedades

• lParam1: identificador CPSUI que hace referencia al conjunto de páginas que se va a eliminar. Este identificador debe haberse obtenido previamente mediante una llamada a ComPropSheet con uno de los siguientes códigos de función:

  • CPSFUNC_ADD_HPROPSHEETPAGE

  • CPSFUNC_ADD_PCOMPROPSHEETUI

  • CPSFUNC_ADD_PFNPROPSHEETUI

  • CPSFUNC_ADD_PROPSHEETPAGE

  • CPSFUNC_INSERT_PSUIPAGE

• lParam2: No se usa, debe ser cero

Valor devuelto (CPSFUNC_DELETE_HCOMPROPSHEET)

La función ComPropSheet devuelve el número de páginas de hoja de propiedades que se eliminaron.

CPSFUNC_DO_APPLY_CPSUI

El código de función CPSFUNC_DO_APPLY_CPSUI hace que la función ComPropSheet simule la entrega de un mensaje de notificación de PSN_APPLY.

CPSUI responde al código de función de CPSFUNC_DO_APPLY_CPSUI al entregar el CPSUICB_REASON_APPLYNOW motivo a la función de devolución de llamada con tipo _CPSUICALLBACK de una aplicación.

Parámetros (CPSFUNC_DO_APPLY_CPSUI)

• hComPropSheet: identificador primario del grupo

• Función: el llamador establece este parámetro de código de función en CPSFUNC_DO_APPLY_CPSUI cuando llama a ComPropSheet para simular la entrega de un mensaje de notificación de PSN_APPLY

• lParam1: identificador CPSUI que apunta a un conjunto de una o varias páginas de hoja de propiedades. Normalmente, este identificador se ha especificado previamente como el parámetro lParam1 en ComPropSheet mediante el código de la función CPSFUNC_IGNORE_CPSUI_PSN_APPLY .

• lParam2: este parámetro es cualquier combinación de las marcas de bits siguientes:

  • APPLYCPSUI_NO_NEWDEF: establezca esta marca si no desea que se cambien los valores predeterminados actuales (usados para la operación Deshacer). Desactive esta marca si desea que los valores actuales de todas las opciones se conviertan en los valores predeterminados usados para la operación Deshacer.

  • APPLYCPSUI_OK_CANCEL_BUTTON: establezca esta marca si el usuario seleccionó el botón Aceptar o Cancelar (o si desea simular esta actividad). Desactive esta marca si el usuario seleccionó el botón Cerrar o Aplicar ahora (o si desea simular esta actividad). Si el código está configurado para recibir mensajes PSN_APPLY , el código debe comprobar el miembro lParam de la estructura PSHNOTIFY . Si el miembro es cero, este bit debe borrarse.

Valor devuelto (CPSFUNC_DO_APPLY_CPSUI)

Si la operación se realiza correctamente, la función ComPropSheet devuelve un valor distinto de cero; de lo contrario, devuelve cero y las páginas especificadas se activarán.

Si usa el código de función CPSFUNC_IGNORE_CPSUI_PSN_APPLY para deshabilitar el control de CPSUI del mensaje de notificación de PSN_APPLY, debe usar el código de función CPSFUNC_DO_APPLY_CPSUI para simular la entrega del mensaje de PSN_APPLY. De lo contrario, no se pueden obtener los cambios de usuario en una página de hoja de propiedades.

CPSFUNC_GET_HPSUIPAGES

El código de función CPSFUNC_GET_HPSUIPAGES hace que la función ComPropSheet devuelva una matriz de identificadores CPSUI que apuntan a páginas de hoja de propiedades. Estos identificadores identifican las páginas secundarias asociadas al identificador primario del grupo especificado.

Para usar este código de función, siga estos pasos:

• Llame a ComPropSheet, especificando el código de función CPSFUNC_GET_PAGECOUNT , para obtener el número de páginas secundarias asociadas al grupo primario especificado.

• Asigne suficiente memoria local para contener una estructura HANDLE para cada página.

• Vuelva a llamar a ComPropSheet , especificando el código de función CPSFUNC_GET_HPSUIPAGES y la dirección de la memoria asignada localmente para obtener una matriz de estructuras HANDLE.

Parámetros (CPSFUNC_GET_HPSUIPAGES)

• hComPropSheet: identificador primario del grupo

• Función: el llamador establece este parámetro de código de función en CPSFUNC_GET_HPSUIPAGES cuando llama a ComPropSheet para recuperar una matriz de identificadores CPSUI.

• lParam1: puntero a una matriz de estructuras HANDLE

• lParam2: tamaño de la matriz HANDLE a la que apunta lParam1

Valor devuelto (CPSFUNC_GET_HPSUIPAGES)

La función ComPropSheet devuelve el número de identificadores que CPSUI coloca en la matriz HANDLE.

CPSFUNC_GET_PAGECOUNT

El código de función CPSFUNC_GET_PAGECOUNT hace que la función ComPropSheet devuelva el número de páginas de hoja de propiedades que son páginas secundarias del identificador primario del grupo especificado.

Parámetros (CPSFUNC_GET_PAGECOUNT)

• hComPropSheet: identificador primario del grupo

• Función: el llamador establece este parámetro de código de función en CPSFUNC_GET_PAGECOUNT cuando llama a ComPropSheet para devolver el recuento de páginas secundarias.

• lParam1: No se usa, debe ser cero

• lParam2: No se usa, debe ser cero

Valor devuelto (CPSFUNC_GET_PAGECOUNT)

La función ComPropSheet devuelve el número de páginas contadas.

CPSFUNC_GET_PFNPROPSHEETUI_ICON

El código de función CPSFUNC_GET_PFNPROPSHEETUI_ICON hace que la función ComPropSheet devuelva un identificador al icono asociado a un conjunto de páginas de hoja de propiedades. El conjunto de páginas debe haber sido creado previamente por una función con tipo PFNPROPSHEETUI.

La función ComPropSheet llama a la función con tipo PFNPROPSHEETUI asociada al identificador de página especificado y pasa un valor de motivo de PROPSHEETUI_REASON_GET_ICON. A continuación, la función con tipo PFNPROPSHEETUI llama a LoadImage y proporciona el tamaño del icono especificado porlParam2 para cargar un recurso de icono.

Parámetros (CPSFUNC_GET_PFNPROPSHEETUI_ICON)

• hComPropSheet: identificador primario del grupo

• Función: el llamador establece este parámetro de código de función en CPSFUNC_GET_PFNPROPSHEETUI_ICON cuando llama a ComPropSheet para recuperar un identificador en el icono asociado a un conjunto de páginas de hoja de propiedades

• lParam1: identificador CPSUI que hace referencia a un conjunto de páginas de hoja de propiedades. Este identificador debe haberse obtenido previamente mediante una llamada a ComPropSheet con el código de función CPSFUNC_ADD_PFNPROPSHEETUI .

• lParam2: especifica dos valores de tamaño WORD que representan el tamaño del icono, en píxeles. El valor LOWORD es el ancho y el valor HIWORD es el alto. Si estos valores son cero, se usan las métricas del sistema SM_CXICON y SM_CYICON. Para obtener más información, consulte GetSystemMetrics.

Valor devuelto (CPSFUNC_GET_PFNPROPSHEETUI_ICON)

Si la operación se realiza correctamente, la función ComPropSheet devuelve un identificador de icono; de lo contrario, devuelve NULL.

CPSFUNC_IGNORE_CPSUI_PSN_APPLY

El código de función CPSFUNC_IGNORE_CPSUI_PSN_APPLY hace que la función ComPropSheet deshabilite o vuelva a habilitar el control de CPSUI del mensaje de notificación de PSN_APPLY .

El sistema envía el mensaje de notificación PSN_APPLY a CPSUI cuando un usuario selecciona el botón Aceptar o Cancelar de una hoja de propiedades. CPSUI responde a este mensaje entregando el motivo del CPSUICB_REASON_APPLYNOW a la función de devolución de llamada con tipo _CPSUICALLBACK de una aplicación.

Si deshabilita el control de CPSUI del mensaje de notificación de PSN_APPLY, debe usar el código de función CPSFUNC_DO_APPLY_CPSUI para simular la entrega del mensaje de PSN_APPLY. De lo contrario, no se pueden obtener los cambios de usuario en una página de hoja de propiedades.

Si no se usa el código de función CPSFUNC_IGNORE_CPSUI_PSN_APPLY , el control de CPSUI del mensaje de notificación de PSN_APPLY está habilitado de forma predeterminada.

Parámetros (CPSFUNC_IGNORE_CPSUI_PSN_APPLY)

• hComPropSheet: identificador primario del grupo

• Función: el llamador establece este parámetro de código de función en CPSFUNC_IGNORE_CPSUI_PSN_APPLY cuando llama a ComPropSheet para deshabilitar o volver a habilitar el control de CPSUI del mensaje de notificación de PSN_APPLY

• lParam1: identificador CPSUI que hace referencia a un conjunto de una o varias páginas de hoja de propiedades. Este identificador debe haberse obtenido previamente mediante una llamada a ComPropSheet con un código de función de CPSFUNC_ADD_PCOMPROPSHEETUI, o con un código de función de CPSFUNC_INSERT_PSUIPAGE y un tipo de inserción de PSUIPAGEINSERT_PROPSHEETPAGE.

• lParam2: cualquier valor distinto de cero deshabilita la entrega de CPSUI del CPSUICB_REASON_APPLYNOW motivo. Un valor cero vuelve a habilitar la entrega del CPSUICB_REASON_APPLYNOW motivo.

Valor devuelto (CPSFUNC_IGNORE_CPSUI_PSN_APPLY)

Si la operación se realiza correctamente, la función ComPropSheet devuelve un valor distinto de cero; de lo contrario, devuelve cero.

CPSFUNC_INSERT_PSUIPAGE

El código de función CPSFUNC_INSERT_PSUIPAGE hace que la función ComPropSheet inserte un conjunto de páginas de hoja de propiedades en una posición específica.

Parámetros (CPSFUNC_INSERT_PSUIPAGE)

• hComPropSheet: identificador primario del grupo

• Función: el llamador establece este parámetro de código de función en CPSFUNC_INSERT_PSUIPAGE cuando llama a ComPropSheet para insertar un conjunto de páginas de hoja de propiedades en una posición específica

• lParam1: especifica un identificador para un conjunto de una o varias páginas de hoja de propiedades. Las nuevas páginas se insertarán antes o después de estas páginas, dependiendo del miembro Mode de la estructura de INSERTPSUIPAGE_INFO a la que apunta lParam2. Este identificador debe haberse obtenido previamente mediante una llamada a ComPropSheet con uno de los siguientes códigos de función:

  • CPSFUNC_ADD_HPROPSHEETPAGE

  • CPSFUNC_ADD_PCOMPROPSHEETUI

  • CPSFUNC_ADD_PFNPROPSHEETUI

  • CPSFUNC_ADD_PROPSHEETPAGE

  • CPSFUNC_INSERT_PSUIPAGE

• lParam2: puntero a una estructura de INSERTPSUIPAGE_INFO , que describe dónde y cómo se deben insertar las nuevas páginas

Valor devuelto (CPSFUNC_INSERT_PSUIPAGE)

Si la operación se realiza correctamente, la función ComPropSheet devuelve un identificador al conjunto de páginas que se insertaron; de lo contrario, la función devuelve NULL.

CPSFUNC_LOAD_CPSUI_ICON

El código de función CPSFUNC_LOAD_CPSUI_ICON hace que la función ComPropSheet cargue un recurso de icono proporcionado por CPSUI.

CPSUI llama a LoadImage para cargar el recurso de icono especificado.

Parámetros (CPSFUNC_LOAD_CPSUI_ICON)

• hComPropSheet: identificador primario del grupo

• Función: el llamador establece este parámetro de código de función en CPSFUNC_LOAD_CPSUI_ICON cuando llama a ComPropSheet para cargar un recurso de icono proporcionado por CPSUI

• lParam1: identificador de recurso del icono proporcionado por CPSUI que se va a cargar. Debe ser un identificador con prefijo IDI_CPSUI tal y como se define en Compstui.h.

• lParam2: especifica dos valores de tamaño WORD que representan el tamaño del icono, en píxeles. El valor LOWORD es el ancho y el valor HIWORD es el alto. Si estos valores son cero, se usan las métricas del sistema SM_CXICON y SM_CYICON. Para obtener más información, consulte GetSystemMetrics.

Valor devuelto (CPSFUNC_LOAD_CPSUI_ICON)

Si la operación se realiza correctamente, la función ComPropSheet devuelve un identificador de icono; de lo contrario, devuelve NULL.

CPSFUNC_LOAD_CPSUI_STRING

El código de función CPSFUNC_LOAD_CPSUI_STRING hace que la función ComPropSheet cargue un recurso de cadena proporcionado por CPSUI.

La función ComPropSheet llama a la función LoadString](/windows/win32/api/winuser/nf-winuser-loadstringw) para cargar la cadena especificada.

Parámetros (CPSFUNC_LOAD_CPSUI_STRING)

• hComPropSheet: identificador primario del grupo

• Función: el llamador establece este parámetro de código de función en CPSFUNC_LOAD_CPSUI_STRING cuando llama a ComPropSheet para cargar un recurso de cadena proporcionado por CPSUI

• lParam1: puntero con tipo LPSTR a un búfer asignado por el autor de la llamada, en el que se colocará la cadena proporcionada por CPSUI especificada por HIWORD(lParam2).

• lParam2: contiene los dos valores proporcionados por el llamador siguientes:

  • LOWORD(lParam2). Tamaño, en bytes, del búfer al que apunta lParam1.

  • HIWORD(lParam2). Identificador de recurso de la cadena proporcionada por CPSUI que se va a cargar. Debe ser un identificador con prefijo IDS_CPSUI tal y como se define en Compstui.h.

Valor devuelto (CPSFUNC_LOAD_CPSUI_STRING)

Si la operación se realiza correctamente, la función ComPropSheet devuelve la longitud de la cadena. Si se especifica un identificador de recurso no válido, la función devuelve cero. Si lParam1 es NULL o LOWORD(lParam2) es cero, la función devuelve -1.

CPSFUNC_QUERY_DATABLOCK

El código de función CPSFUNC_QUERY_DATABLOCK hace que la función ComPropSheet recupere un bloque de datos proporcionado por el autor de la llamada que se almacenó anteriormente mediante el código de función CPSFUNC_SET_DATABLOCK .

Normalmente, una función de devolución de llamada con tipo _CPSUICALLBACK usa este código de función (cuando la estructura CPSUICBPARAM de la función contiene un valor Reason de CPSUICB_REASON_SETACTIVE) para recuperar los valores asociados a otra página antes de que la página actual esté inactiva.

Parámetros (CPSFUNC_QUERY_DATABLOCK)

• hComPropSheet: identificador primario del grupo

• Función: el llamador establece este parámetro de código de función en CPSFUNC_QUERY_DATABLOCK cuando llama a ComPropSheet para recuperar un bloque de datos proporcionado por el autor de la llamada

• lParam1: puntero a una estructura CPSUIDATABLOCK que identifica el tamaño y la ubicación de un búfer para recibir el bloque de datos solicitado.

• lParam2: valor de identificador de tamaño DWORD, usado para identificar la estructura CPSUIDATABLOCK solicitada. Este valor debe haberse especificado en una llamada anterior a ComPropSheet mediante el código de función CPSFUNC_SET_DATABLOCK .

Valor devuelto (CPSFUNC_QUERY_DATABLOCK)

Si la operación se realiza correctamente, la función ComPropSheet devuelve un valor que representa el tamaño del bloque de datos recuperado. Si lParam1 es NULL o si el valor de cualquier miembro de la estructura CPSUIDATABLOCK proporcionada es cero, ComPropSheet devuelve el tamaño necesario para almacenar el bloque de datos. Si se produce un error, la función devuelve un valor menor o igual que cero.

CPSFUNC_SET_DATABLOCK

El código de función CPSFUNC_SET_DATABLOCK hace que la función ComPropSheet almacene un bloque de datos proporcionado por el autor de la llamada. Puede usar este código de función para que la información sobre una página de hoja de propiedades esté disponible para otras páginas.

Normalmente, una función de devolución de llamada con tipo _CPSUICALLBACK usa este código de función (cuando la estructura CPSUICBPARAM de la función contiene un valor reason de CPSUICB_REASON_KILLACTIVE) para guardar los valores asociados a una página antes de que se vuelva inactivo.

Parámetros (CPSFUNC_SET_DATABLOCK)

• hComPropSheet: identificador primario del grupo

• Función: el autor de la llamada establece este parámetro de código de función en CPSFUNC_SET_DATABLOCK cuando llama a ComPropSheet para almacenar un bloque de datos proporcionado por el autor de la llamada

• lParam1: puntero a una estructura CPSUIDATABLOCK que describe el bloque de datos que se va a almacenar

• lParam2: valor de identificador de tamaño DWORD definido por el autor de la llamada. Se usa para identificar la estructura CPSUIDATABLOCK proporcionada en llamadas posteriores a ComPropSheet mediante el código de función CPSFUNC_QUERY_DATABLOCK .

Valor devuelto (CPSFUNC_SET_DATABLOCK)

Si la operación se realiza correctamente, la función ComPropSheet devuelve un valor que representa el número de bytes almacenados; de lo contrario, devuelve un valor menor o igual que cero.

CPSFUNC_SET_DMPUB_HIDEBITS

El código de función CPSFUNC_SET_DMPUB_HIDEBITS hace que la función ComPropSheet "oculte" un conjunto especificado de opciones de propiedad de documento, de modo que no se muestren.

Puede usar el código de función CPSFUNC_SET_DMPUB_HIDEBITS si desea definir estructuras OPTITEM para una o varias opciones de hoja de propiedades de documento, pero no desea que las opciones sean modificables por el usuario. La página de hoja de propiedades debe definirse mediante la estructura COMPROPSHEETUI y el miembro pDlgPage de la estructura debe ser CPSUI_PDLGPAGE_DOCPROP o CPSUI_PDLGPAGE_ADVDOCPROP.

Si usa el código de función CPSFUNC_SET_DMPUB_HIDEBITS , debe especificarse en ComPropSheet antes de que se use el código de función CPSFUNC_ADD_PCOMPROPSHEETUI o CPSFUNC_INSERT_PSUIPAGE para crear la página.

Parámetros (CPSFUNC_SET_DMPUB_HIDEBITS)

• hComPropSheet: identificador primario del grupo

• Función: el llamador establece este parámetro de código de función en CPSFUNC_SET_DMPUB_HIDEBITS cuando llama a ComPropSheet para "ocultar" un conjunto especificado de opciones de propiedad de documento

• lParam1: puntero a una matriz de bits que indica las opciones que se van a ocultar. Esta matriz debe crearse con la macro MAKE_DMPUB_HIDEBIT(DMPub), donde DMPub es la combinación OR de una o varias constantes con prefijo DMPUB_. Las constantes DMPUB_ prefijo se enumeran en la descripción de la estructura OPTITEM . La macro y las constantes se definen en Compstui.h.

• lParam2: No se usa, debe ser cero

Valor devuelto (CPSFUNC_SET_DMPUB_HIDEBITS)

Si la operación se realiza correctamente, la función ComPropSheet devuelve el valor especificado para lParam1; de lo contrario, devuelve cero.

CPSFUNC_SET_FUSION_CONTEXT

El CPSFUNC_SET_FUSION_CONTEXT establece un contexto de activación de Fusion para la página especificada.

Cuando una página está a punto de crearse o insertarse y no especifica un contexto de activación en su estructura PROPSHEETPAGE , se creará en el contexto de activación de página principal.

Si no se establece el contexto de activación del elemento primario, Compstui.dll busca el elemento primario del elemento primario, continuando hasta que se alcanza el elemento primario de nivel superior o hasta que encuentre un elemento primario con un contexto de activación establecido correctamente.

Si ninguno de los elementos primarios tiene establecido un contexto de activación, Compstui.dll no especificará un contexto de activación en la estructura PROPSHEETPAGE . Esto significa que la página se creará en el contexto de activación del autor de la llamada de la función PropertySheet .

Parámetros (CPSFUNC_SET_FUSION_CONTEXT)

• hComPropSheet: identificador primario del grupo

• Función: el llamador establece este parámetro de código de función en CPSFUNC_SET_FUSION_CONTEXT cuando llama a ComPropSheet para establecer un contexto de activación de Fusion para la página especificada

• lParam1: especifica el identificador para el contexto de Fusión. Compstui.dll duplica el identificador, lo adjunta a sus estructuras internas, de modo que el autor de la llamada no esté obligado a conservar el identificador. Compstui.dll libera el identificador de contexto pasado cuando se elimina el identificador de Compstui.dll.

• lParam2: No se usa, debe ser cero

Valor devuelto (CPSFUNC_SET_FUSION_CONTEXT)

Si la operación se realiza correctamente, la función ComPropSheet devuelve un valor mayor que cero. De lo contrario, ComPropSheet devuelve un valor menor o igual que cero. Para obtener información sobre el error, use la función GetLastError .

CPSFUNC_SET_HSTARTPAGE

El código de función CPSFUNC_SET_HSTARTPAGE hace que la función ComPropSheet marque una página de hoja de propiedades especificada para que sea la página superior de la hoja de propiedades asociada. Si la hoja de propiedades se muestra actualmente, la página especificada se convierte en la página activa.

Parámetros (CPSFUNC_SET_HSTARTPAGE)

• hComPropSheet: identificador primario del grupo

• Función: el autor de la llamada establece este parámetro de código de función en CPSFUNC_SET_HSTARTPAGE cuando llama a ComPropSheet para marcar una página de hoja de propiedades especificada para que sea la página superior de la hoja de propiedades asociada.

• lParam1: identificador de página CPSUI proporcionado por el autor de la llamada, obtenido previamente por una llamada a ComPropSheet con uno de los siguientes códigos de función:

  • CPSFUNC_ADD_HPROPSHEETPAGE

  • CPSFUNC_ADD_PCOMPROPSHEETUI

  • CPSFUNC_ADD_PFNPROPSHEETUI

  • CPSFUNC_ADD_PROPSHEETPAGE

  • CPSFUNC_INSERT_PSUIPAGE

  Si el identificador representa una sola página que pertenece al grupo especificado por hComPropSheet, CPSUI convierte esta página en la página superior.

  Si el identificador representa un identificador primario del grupo (vea CPSFUNC_INSERT_PSUIPAGE), lParam2 representa un índice de base cero en las páginas del grupo y la página representada por el índice se convierte en la página superior.

• lParam2: si lParam1 representa un identificador primario del grupo, este valor proporcionado por el autor de la llamada es un índice de base cero en las páginas del grupo. Si lParam1 representa una sola página que pertenece al grupo especificado por hComPropSheet, este parámetro no se usa. Si el identificador especificado por lParam1 se obtuvo mediante el código de función CPSFUNC_ADD_PCOMPROPSHEETUI y si el miembro pDlgPage de la estructura COMPROPSHEETUI asociada se estableció en CPSUI_PDLGPAGE_DOCPROP, se puede especificar uno de los siguientes valores para lParam2:

  • SSP_STDPAGE1: haga que la página Diseño sea la página superior.

  • SSP_STDPAGE2: haga que la página Papel/Calidad sea la página superior.

  • SSP_TVPAGE: haga que la página Avanzada sea la página superior.

Valor devuelto (CPSFUNC_SET_HSTARTPAGE)

Si la operación se realiza correctamente, la función ComPropSheet devuelve el valor especificado para lParam1; de lo contrario, devuelve cero.

CPSFUNC_SET_PSUIPAGE_ICON

El código de función CPSFUNC_SET_PSUIPAGE_ICON hace que la función ComPropSheet agregue, reemplace o quite el icono asignado a la pestaña de una página de hoja de propiedades.

Si lParam2 contiene un identificador de icono y si se muestra la página especificada por lParam1, CPSUI agrega el icono a la pestaña de la página especificada. Si ya se ha asignado un icono a la página, el icono anterior se reemplaza por el nuevo. Si lParam2 es cero, se quita el icono actual (si existe uno).

Para todos los iconos especificados con el código de función CPSFUNC_SET_PSUIPAGE_ICON , CPSUI establece el tamaño de imagen en 16 en 16 píxeles.

Los identificadores de icono se deben obtener llamando a LoadImage.

Parámetros (CPSFUNC_SET_PSUIPAGE_ICON)

• hComPropSheet: identificador primario del grupo

• Función: el llamador establece este parámetro de código de función en CPSFUNC_SET_PSUIPAGE_ICON cuando llama a ComPropSheet para agregar, reemplazar o quitar el icono asignado a la pestaña de una página de hoja de propiedades

• lParam1: identificador de página CPSUI proporcionado por el autor de la llamada, obtenido previamente por una llamada a ComPropSheet con uno de los siguientes códigos de función:

  • CPSFUNC_ADD_HPROPSHEETPAGE

  • CPSFUNC_ADD_PROPSHEETPAGE

  • CPSFUNC_INSERT_PSUIPAGE (con el miembro Type de la estructura INSERTPSUIPAGE_INFO establecida en PSUIPAGEINSERT_HPROPSHEETPAGE o PSUIPAGEINSERT_PROPSHEETPAGE)

• lParam2: identificador de icono proporcionado por el autor de la llamada. Puede establecer este parámetro en cero para quitar el icono actual.

Valor devuelto (CPSFUNC_SET_PSUIPAGE_ICON)

Si la operación se realiza correctamente, la función ComPropSheet devuelve 1. Si se produce un error o si la página especificada no se muestra actualmente, la función devuelve cero.

CPSFUNC_SET_PSUIPAGE_TITLE

El código de función CPSFUNC_SET_PSUIPAGE_TITLE hace que la función ComPropSheet establezca el título de la pestaña para una página de hoja de propiedades.

Parámetros (CPSFUNC_SET_PSUIPAGE_TITLE)

• hComPropSheet: identificador primario del grupo

• Función: el llamador establece este parámetro de código de función en CPSFUNC_SET_PSUIPAGE_TITLE cuando llama a ComPropSheet para establecer el título de la pestaña de una página de hoja de propiedades

• lParam1: identificador de página CPSUI proporcionado por el autor de la llamada, obtenido previamente por una llamada a ComPropSheet con uno de los siguientes códigos de función:

  • CPSFUNC_ADD_HPROPSHEETPAGE

  • CPSFUNC_ADD_PROPSHEETPAGE

  • CPSFUNC_INSERT_PSUIPAGE (con el miembro Type de la estructura INSERTPSUIPAGE_INFO establecida en PSUIPAGEINSERT_HPROPSHEETPAGE o PSUIPAGEINSERT_PROPSHEETPAGE).

• lParam2: puntero proporcionado por el llamador a una cadena terminada en NULL que especifica el nuevo título

Valor devuelto (CPSFUNC_SET_PSUIPAGE_TITLE)

Si la operación se realiza correctamente, la función ComPropSheet devuelve 1. Si se produce un error o si la página especificada no se muestra actualmente, la función devuelve cero.

CPSFUNC_SET_RESULT

El código de función CPSFUNC_SET_RESULT hace que la función ComPropSheet pase un valor de resultado especificado a todas las funciones con tipo PFNPROPSHEETUI asociadas a una página especificada y a sus elementos primarios.

Para obtener más información sobre cómo establecer valores de resultado, vea la descripción de la estructura SETRESULT_INFO .

La siguiente precaución se aplica al complemento de interfaz de usuario IHV basado en Unidrv o Pscript5 con hojas de propiedades de interfaz de usuario personalizadas y para qué configuración de usuario realizada en las hojas de propiedades debe ser persistente. Cuando el complemento llama a la función ComPropSheet con el parámetro Function establecido en CPSFUNC_SET_RESULT, el complemento debe establecer el parámetro lParam2 en CPSUI_OK.

Parámetros (CPSFUNC_SET_RESULT)

• hComPropSheet: identificador primario del grupo

• Función: el llamador establece este parámetro de código de función en CPSFUNC_SET_RESULT cuando llama a ComPropSheet para pasar un valor de resultado especificado a todas las funciones con tipo PFNPROPSHEETUI asociadas a una página especificada y a sus elementos primarios.

• lParam1: identificador CPSUI proporcionado por el autor de la llamada a la página para la que se pasa un valor de resultado. Si lParam1 es NULL, CPSUI usa el valor especificado por hComPropSheet.

• lParam2: valor de resultado DWORD proporcionado por el llamador de 32 bits.

Valor devuelto (CPSFUNC_SET_RESULT)

Si la operación se realiza correctamente, la función ComPropSheet devuelve el número de funciones con tipo PFNPROPSHEETUI a las que se llamó. Si el identificador especificado para lParam1 no es válido, la función devuelve -1.

Requisitos

Requisito	Value
Plataforma de destino	Escritorio
Encabezado	compstui.h (incluir Compstui.h)