Método IPrintOemUI::CommonUIProp (prcomoem.h)

El IPrintOemUI::CommonUIProp método permite que un complemento de interfaz de usuario modifique una página de hojas de propiedades de impresora existente.

Sintaxis

HRESULT CommonUIProp(
  DWORD         dwMode,
  POEMCUIPPARAM pOemCUIPParam
);

Parámetros

dwMode

Constante entera proporcionada por el autor de la llamada que indica qué página de hoja de propiedades se debe modificar. Las siguientes constantes son válidas.

Value	Definición
OEMCUIP_DOCPROP	Se llama al método para modificar la página Diseño, Papel/Calidad o Avanzadas de la hoja de propiedades del documento.
OEMCUIP_PRNPROP	Se llama al método para modificar la página Configuración del dispositivo de la hoja de propiedades de la impresora.

pOemCUIPParam

Puntero proporcionado por el autor de la llamada a una estructura OEMCUIPPARAM .

Valor devuelto

El método debe devolver uno de los valores siguientes.

Código devuelto	Descripción
S_OK	La operación se realizó correctamente.
E_FAIL	Error en la operación.
E_NOTIMPL	El método no está implementado.

Comentarios

Cuando se llama al método de un complemento de interfaz de IPrintOemUI::CommonUIProp usuario, debe devolver elementos de opción de hoja de propiedades personalizados para modificar una página de hoja de propiedades de impresora existente.

El IPrintOemUI::CommonUIProparchivo DLL de la interfaz de impresora llama al método . El método debe proporcionar una matriz de estructuras OPTITEM que describen elementos de hoja de propiedades, junto con una función de devolución de llamada para procesar las modificaciones del usuario en valores de opción.

Debe esperar que se llame al método dos veces para cada hoja de propiedades. El valor del parámetro dwMode del método indica si se llama a para realizar cambios en la hoja de propiedades de la impresora o en la hoja de propiedades del documento.

La primera vez que se llama, el método solo debe devolver el número de estructuras OPTITEM que se van a agregar. Este número debe colocarse en el miembro cOEMOptItems de la estructura OEMCUIPPARAM. A continuación, el archivo DLL de la interfaz de impresora asigna suficiente memoria para almacenar el número especificado de OPTITEMs y llama IPrintOemUI::CommonUIProp de nuevo.

La segunda vez que se llama, el IPrintOemUI::CommonUIProp método debe hacer lo siguiente:

• Rellene la matriz proporcionada por el controlador de estructuras OPTITEM con descripciones de opciones. Esta matriz apunta al miembro pOEMOptItems de la estructura OEMCUIPPARAM y el número de elementos de matriz asignados se encuentra en el miembro cOEMOptItems de la estructura. (Para obtener información sobre cómo especificar valores de miembro OPTITEM, vea la descripción del miembro pOEMOptItems de la estructura OEMCUIPPARAM).
• Devuelve el número de estructuras agregadas a la matriz OPTITEM colocando el número en el miembro cOEMOptItems de la estructura OEMCUIPPARAM.
• Devuelve la dirección de una función de devolución de llamada en el miembro OEMCUIPPARAM de la estructura OEMCUIPCallback . Se llama a esta función de devolución de llamada cuando un usuario modifica la página de la hoja de propiedades. La función de devolución de llamada debe ser de tipo OEMCUIPCALLBACK.
• Opcionalmente, devuelva la dirección de una estructura de datos privada colocándola en el miembro pOEMUserData de la estructura OEMCUIPPARAM. La función de devolución de llamada especificada por el miembro OEMCUIPCallback de la estructura de la estructura OEMCUIPPARAM recibe la dirección de la estructura OEMCUIPPARAM como parámetro de entrada y, por tanto, puede obtener la dirección de los datos privados.

  Se debe asignar espacio para la estructura de datos privada llamando a la función Microsoft Windows SDK HeapAlloc, mediante el identificador contenido en el miembro hOEMHeap de la estructura OEMCUIPPARAM.

Si IPrintOemUI::CommonUIProp varios complementos de interfaz de usuario exportan métodos, se llama a los métodos en el orden en que se especifican los complementos para la instalación.

Para obtener más información, vea Modificar una página de hoja de propiedades de Driver-Supplied.

Requisitos

Requisito	Value
Plataforma de destino	Escritorio
Encabezado	prcomoem.h (include Prcomoem.h)