Funciones definidas por proveedores de impresión
Advertencia
A partir de Windows 10, las API que admiten proveedores de impresión de terceros están en desuso. Microsoft no recomienda ninguna inversión en proveedores de impresión de terceros. Además, en Windows 8 y productos más recientes en los que el modelo de controlador de impresión v4 está disponible, es posible que los proveedores de impresión de terceros no creen ni administren colas que usen controladores de impresión v4.
En este tema se enumeran todas las funciones que puede proporcionar un proveedor de impresión. La mayoría de estas funciones se describen en la documentación de Microsoft Windows SDK. Si la función se describe en el Kit de controladores de Windows (WDK), el nombre de la función proporciona un vínculo a la página de referencia asociada.
Todos los proveedores de impresión deben proporcionar punteros para todas las funciones enumeradas. Sin embargo, la mayoría de los proveedores de impresión suministrados por el proveedor son "proveedores parciales" que no necesitan admitir muchas de las operaciones definidas por las funciones. Por lo tanto, muchos de los punteros de función pueden ser NULL. Para obtener más información sobre los proveedores de impresión parciales, consulte Escritura de un proveedor de impresión de red.
En las listas de funciones siguientes, las funciones que se deben admitir se etiquetan como "Obligatorio".
Todos los proveedores de impresión deben exportar la función de inicialización InitializePrintProvidor. Los punteros a todas las demás funciones deben proporcionarse en una estructura PRINTPROVIDOR . (Tenga en cuenta que estos dos nombres están mal escritos, pero son coherentes con los nombres que aparecen en el archivo de encabezado Winsplp.h).
Las funciones se dividen en grupos y se presentan en las secciones siguientes:
Función de inicialización
Funciones de administración de colas de impresión
Funciones de administración de controladores de impresora
Funciones de creación de trabajos de impresión
Funciones de programación de trabajos de impresión
Funciones de administración de formularios
Funciones de administración del procesador de impresión
Funciones de administración del monitor de impresión
Funciones de administración de puertos
Funciones de administración del Registro
Otras funciones
Función de inicialización
| Función | Descripción |
|---|---|
| InitializePrintProvidor (obligatorio) | Inicializa el proveedor de impresión y devuelve punteros a funciones proporcionadas. |
Funciones de administración de colas de impresión
| Función | Descripción |
|---|---|
| Addprinter | Agrega una cola de impresión a la lista de las administradas por el proveedor de impresión y asocia un procesador de impresión a la cola de impresión. |
| AddPrinterConnection | Crea una conexión a la cola de impresión especificada. |
| ClosePrinter (obligatorio) | Deshabilita el acceso del autor de la llamada a una cola de impresión especificada. |
| DeletePrinter | Elimina una cola de impresión de la lista de las administradas por el proveedor de impresión. |
| DeletePrinterConnection | Quita una conexión a la cola de impresión especificada. |
| EnumPrinters (obligatorio) | Enumera la lista de colas de impresión administradas actualmente por el proveedor de impresión. |
| FindClosePrinterChangeNotification | Deshabilita las notificaciones de cambio de impresora habilitadas por FindFirstPrinterChangeNotification. |
| FindFirstPrinterChangeNotification | Devuelve un identificador a un objeto de espera que el autor de la llamada puede usar para esperar eventos de impresora especificados. |
| GetPrinter (obligatorio) | Devuelve los valores de parámetro actuales de una cola de impresión especificada. |
| OpenPrinter (obligatorio) | Habilita el acceso del autor de la llamada a una cola de impresión especificada. |
| RefreshPrinterChangeNotification | Llamado por enrutador si el cliente llama a FindNextPrinterChangeNotification con la marca PRINTER_NOTIFY_OPTIONS_REFRESH establecida. |
| ResetPrinter | Modifica el tipo de datos de una cola de impresión o la estructura DEVMODEW . |
| SetPrinter (obligatorio) | Establece parámetros para una cola de impresión especificada. |
| WaitForPrinterChange | Obsoleto. |
Funciones de administración de controladores de impresora
| Función | Descripción |
|---|---|
| AddPrinterDriver | Agrega los archivos de controlador de una impresora especificada a un servidor especificado. |
| AddPrinterDriverEx | Igual que AddPrinterDriver, con parámetros adicionales. |
| DeletePrinterDriver | Elimina el acceso a los archivos de controlador de una impresora especificada, en un servidor especificado. |
| DeletePrinterDriverEx | Igual que DeletePrinterDriver, con parámetros adicionales. |
| EnumPrinterDrivers | Devuelve una lista de controladores de impresora que se han agregado a un servidor especificado llamando a AddPrinterDriver o AddPrinterDriverEx. |
| GetPrinterDriver | Devuelve información sobre un controlador de impresora, que el autor de la llamada puede pasar a AddPrinterDriver. (La información devuelta se obtiene normalmente de un archivo INF). |
| [GetPrinterDriverEx | Igual que GetPrinterDriver, con parámetros adicionales. |
| GetPrinterDriverDirectory | Devuelve el nombre del directorio del controlador de impresora del servidor. |
Funciones de creación de trabajos de impresión
| Función | Descripción |
|---|---|
| AbortPrinter (obligatorio) | Intenta eliminar el trabajo actual de la cola de impresión especificada. |
| AddJob (obligatorio) | Devuelve un identificador de trabajo y una ruta de acceso del archivo de cola. El autor de la llamada usa CreateFile y WriteFile para enviar datos al archivo de cola. |
| EndDocPrinter (obligatorio) | Realiza operaciones de finalización de trabajos. |
| EndPagePrinter | Realiza operaciones de finalización de páginas. |
| ReadPrinter | Obtiene información de estado de una impresora bidireccional. |
| ScheduleJob (obligatorio) | Informa al proveedor de que se puede programar un trabajo especificado. El trabajo se especifica mediante un identificador de trabajo devuelto anteriormente por AddJob. |
| StartDocPrinter (obligatorio) | Prepara el proveedor de impresión para empezar a poner en cola un trabajo de impresión. |
| StartPagePrinter | Prepara el proveedor de impresión para recibir una página de trabajo de impresión. |
| WritePrinter (obligatorio) | Recibe una parte del flujo de datos del trabajo de impresión. |
Nota
AddJob... La secuencia ScheduleJob es una alternativa a StartDocPrinter... Secuencia endDocPrinter.
Funciones de programación de trabajos de impresión
| Función | Descripción |
|---|---|
| EnumJobs (obligatorio) | Devuelve una lista de trabajos de impresión programados. |
| GetJob (obligatorio) | Devuelve parámetros de trabajo. |
| SetJob (obligatorio) | Cancela, pausa, reanuda o reinicia un trabajo de impresión o establece parámetros de trabajo. |
Funciones de administración de formularios
| Función | Descripción |
|---|---|
| AddForm | Agrega un formulario especificado a la lista de los disponibles para una impresora especificada. |
| DeleteForm | Quita un formulario especificado de la lista de los disponibles para una impresora especificada. |
| EnumForms | Devuelve una lista de formularios disponibles para una impresora especificada. |
| GetForm | Devuelve características de un formulario especificado. |
| SetForm | Modifica las características de un formulario especificado. |
Funciones de administración del procesador de impresión
| Función | Descripción |
|---|---|
| AddPrintProcessor | Instala un procesador de impresión en el servidor especificado y lo agrega a la lista de aquellos a los que puede llamar el proveedor de impresión. |
| DeletePrintProcessor | Elimina un procesador de impresión de la lista de aquellos a los que puede llamar el proveedor de impresión. |
| EnumPrintProcessorDataTypes | Devuelve una lista de los tipos de datos admitidos por los procesadores de impresión a los que puede llamar el proveedor de impresión. |
| EnumPrintProcessors | Devuelve la lista de procesadores de impresión a los que puede llamar el proveedor de impresión. |
| GetPrintProcessorDirectory | Devuelve la ruta de acceso del directorio en la que se deben almacenar los archivos de procesador de impresión. |
Funciones de administración del monitor de impresión
| Función | Descripción |
|---|---|
| AddMonitor | Agrega un monitor de impresión a la lista de aquellos a los que puede llamar el proveedor de impresión. |
| DeleteMonitor | Elimina un monitor de impresión de la lista de los a los que puede llamar el proveedor de impresión. |
| EnumMonitors | Devuelve la lista de monitores de impresión a los que puede llamar el proveedor de impresión. |
Funciones de administración de puertos
| Función | Descripción |
|---|---|
| AddPort | Agrega un puerto de impresora a la lista de los disponibles, normalmente llamando a la función AddPortUI del monitor de puerto especificado. |
| AddPortEx(/previous-versions/ff545025(v%3dvs.85)) | Igual que AddPort, con parámetros adicionales. |
| ConfigurePort (obligatorio) | Configura un puerto de impresora, normalmente llamando a la función ConfigurePortUI del monitor de puertos especificado. |
| DeletePort (obligatorio) | Elimina un puerto de impresora de la lista de los disponibles, normalmente llamando a la función DeletePortUI del monitor de puerto especificado. |
| EnumPorts (obligatorio) | Devuelve una lista de puertos de impresora disponibles. |
| SetPort | Establece parámetros para un puerto de impresora especificado. |
Funciones de administración del registro
| Función | Descripción |
|---|---|
| DeletePrinterData | Elimina el valor asignado actualmente a un nombre de valor especificado, bajo la clave PrinterDriverData de la impresora especificada. |
| DeletePrinterDataEx | Igual que DeletePrinterData, con parámetros adicionales. |
| DeletePrinterKey | Elimina una clave especificada y sus subclaves, si están almacenadas actualmente en el Registro en la clave PrinterDriverData de la impresora especificada. |
| EnumPrinterData | Devuelve cada uno de los nombres de valor y los valores asignados actualmente almacenados en el Registro bajo la clave PrinterDriverData de la impresora especificada. |
| EnumPrinterDataEx | Igual que EnumPrinterData, con parámetros adicionales. |
| EnumPrinterKey | Devuelve una lista de subclaves que se encuentran actualmente en el Registro bajo un nombre de clave especificado. |
| GetPrinterData | Devuelve el valor asignado actualmente a un nombre de valor especificado, que se almacena en el Registro bajo la clave PrinterDriverData de la impresora especificada. |
| GetPrinterDataEx | Igual que GetPrinterData, con parámetros adicionales. |
| SetPrinterData | Almacena un nombre de valor y un valor especificados en el Registro, en la clave PrinterDriverData de la impresora especificada. |
| SetPrinterDataEx | Igual que SetPrinterData, con parámetros adicionales. |
Otras funciones
| Función | Descripción |
|---|---|
| XcvData | Proporciona una ruta de comunicación entre un archivo DLL de interfaz de usuario del monitor de puerto y un archivo DLL del servidor de supervisión de puertos. |