Estructura COMPROPSHEETUI (compstui.h)

Artículo
03/08/2023

La estructura COMPROPSHEETUI se usa como parámetro de entrada para la función ComPropSheet de CPSUI, si el código de función es CPSFUNC_ADD_PCOMPROPSHEETUI. El autor de la llamada de ComPropSheet debe proporcionar todos los miembros de la estructura.

Sintaxis

typedef struct _COMPROPSHEETUI {
  WORD           cbSize;
  WORD           Flags;
  HINSTANCE      hInstCaller;
  LPTSTR         pCallerName;
  ULONG_PTR      UserData;
  LPTSTR         pHelpFile;
  _CPSUICALLBACK pfnCallBack;
  POPTITEM       pOptItem;
  PDLGPAGE       pDlgPage;
  WORD           cOptItem;
  WORD           cDlgPage;
  ULONG_PTR      IconID;
  LPTSTR         pOptItemName;
  WORD           CallerVersion;
  WORD           OptItemVersion;
  ULONG_PTR      dwReserved[4];
} COMPROPSHEETUI, *PCOMPROPSHEETUI;

Miembros

cbSize

Tamaño proporcionado por el autor de la llamada, en bytes, de la estructura COMPROPSHEETUI .

Flags

Marcas de bits proporcionadas por el autor de la llamada opcionales, como se describe en la lista siguiente:

CPSUIF_ABOUT_CALLBACK

Si se establece, la función de devolución de llamada de la página (a la que apunta el miembro pfnCallback de la estructura), admite CPSUICB_REASON_ABOUT, por lo que CPSUI llamará a la función de devolución de llamada si el usuario hace clic en el botón Acerca de la página. (CPSUI proporciona un botón Acerca de para cada nodo raíz de vista de árbol).

CPSUIF_ICONID_AS_HICON

Si se establece, el miembro IconID de la estructura contiene un identificador de icono.

Si no se establece, el miembro IconID contiene un identificador de recurso de icono.

CPSUIF_UPDATE_PERMISSION

Si se establece, el usuario puede modificar los valores de opción de la página.

hInstCaller

Identificador de instancia del módulo proporcionado por el autor de la llamada, recibido por la función de punto de entrada del archivo DLL.

pCallerName

Puntero proporcionado por el autor de la llamada a una cadena de texto terminada en NULL que representa el nombre de la aplicación. (Para un archivo DLL de interfaz de impresora, debe ser el nombre del controlador, como "Controlador PostScript").

UserData

Valor proporcionado por el autor de la llamada opcional, que CPSUI coloca en el miembro UserData de una estructura CPSUICBPARAM al llamar a la función a la que apunta pfnCallBack.

pHelpFile

Puntero proporcionado por el autor de la llamada a una cadena de texto terminada en NULL que representa una ruta de acceso a un archivo de ayuda. En el caso de los archivos DLL de interfaz de impresora, suele ser la ruta de acceso del archivo de ayuda obtenida mediante una llamada a GetPrinterDriver.

El archivo de ayuda se indexa por los valores contenidos en el miembro HelpIndex de estructuras OPTITEM .

pfnCallBack

Puntero proporcionado por el autor de la llamada a una función de devolución de llamada con tipo _CPSUICALLBACK, que CPSUI llama cuando un usuario modifica los valores de opción de la página.

Solo se puede usar si pDlgPage identifica una estructura DLGPAGE proporcionada por CPSUI o si el miembro DlgProc de una estructura DLGPAGE proporcionada por la aplicación es NULL.

pOptItem

Puntero proporcionado por el autor de la llamada a una matriz de estructuras OPTITEM que describen las opciones de la página.

pDlgPage

Este miembro especifica estructuras DLGPAGE que describen las páginas que se van a agregar a la hoja de propiedades. Puede ser cualquiera de las siguientes alternativas:

Puntero a una matriz de estructuras DLGPAGE.
Uno de los punteros que se describen en la lista siguiente. Estos punteros hacen referencia a estructuras DLGPAGE predefinidas, proporcionadas por CPSUI para su uso por dll de interfaz de impresora.
- CPSUI_PDLGPAGE_ADVDOCPROP
  
  Define una página de vista de árbol cuya pestaña lee Avanzadas. Solo lo usa una función DrvDocumentPropertySheets .
- CPSUI_PDLGPAGE_DOCPROP
  
  Define tres páginas, cuyas pestañas son Diseño, Papel/Calidad y Avanzadas. La página Avanzadas es una vista de árbol. Solo lo usa una función DrvDocumentPropertySheets .
- CPSUI_PDLGPAGE_PRINTERPROP
  
  Define una página de vista de árbol cuya pestaña lee Configuración del dispositivo. Solo lo usa una función DrvDevicePropertySheets .
- CPSUI_PDLGPAGE_TREEVIEWONLY
  
  Define una página de vista de árbol.

cOptItem

Número proporcionado por el autor de la llamada de estructuras OPTITEM a las que apunta pOptItem.

cDlgPage

Número proporcionado por el autor de la llamada de estructuras DLGPAGE a las que apunta pDlgPage. No se usa si pDlgPage especifica una estructura prefijo CPSUI_PDLGPAGE prefijo prefijo prefijo predefinida.

IconID

El autor de la llamada proporcionado puede ser uno de los siguientes:

Un identificador de recurso de icono. Esto puede ser definido por la aplicación o puede ser uno de los identificadores de recursos de recursos de icono con prefijos de CPSUI IDI_CPSUI proporcionados por CPSUI.
Identificador de icono. Si se especifica un identificador, CPSUIF_ICONID_AS_HICON debe establecerse en el miembro Flags .

El icono especificado se muestra en el nodo raíz de la vista de árbol de la página de la hoja de propiedades.

pOptItemName

Puntero proporcionado por el autor de la llamada a una cadena terminada en NULL que se mostrará en el nodo raíz de la vista de árbol de la página de la hoja de propiedades. En el caso de los archivos DLL de interfaz de impresora, esta cadena suele representar un tipo de dispositivo de impresora, como "HP 4si".

CallerVersion

Número de versión proporcionado por el autor de la llamada, que representa la versión actual de la aplicación que realiza la llamada. El byte alto identifica la versión principal y el byte bajo es la versión secundaria. Por ejemplo, un valor callerVersion de 0x310 especifica un número de versión del autor de la llamada de 3.16. El número de versión se muestra cuando un usuario hace clic en el botón Acerca de una página.

OptItemVersion

Número de versión proporcionado por el autor de la llamada, que representa la versión actual del elemento de opción de nivel raíz. En el caso de los archivos DLL de interfaz de impresora, normalmente representa una versión de dispositivo de impresora. El byte alto identifica la versión principal y el byte bajo es la versión secundaria. Por ejemplo, un valor OptItemVersion de 0x3ff especifica un número de versión del autor de la llamada de 3.255. El número de versión se muestra cuando un usuario hace clic en el botón Acerca de una página.

dwReserved[4]

Reservado. Esta matriz debe establecerse en cero.

Requisitos

Requisito	Valor
Header	compstui.h (incluya Compstui.h)

Compartir a través de