Función SetPrinterData

La función SetPrinterData establece los datos de configuración de una impresora o servidor de impresión.

Para especificar la clave del Registro en la que se van a almacenar los datos, llame a la función SetPrinterDataEx . Llamar a SetPrinterData equivale a llamar a la función SetPrinterDataEx con el parámetro pKeyName establecido en "PrinterDriverData".

Sintaxis

DWORD SetPrinterData(
  _In_ HANDLE hPrinter,
  _In_ LPTSTR pValueName,
  _In_ DWORD  Type,
  _In_ LPBYTE pData,
  _In_ DWORD  cbData
);

Parámetros

hPrinter [in]

Identificador de la impresora o del servidor de impresión para el que la función establece los datos de configuración. Use la función OpenPrinter, OpenPrinter2 o AddPrinter para recuperar un identificador de impresora.

pValueName [in]

Puntero a una cadena terminada en null que identifica los datos que se van a establecer.

En el caso de las impresoras, esta cadena es el nombre de un valor del Registro en la clave "PrinterDriverData" de la impresora en el Registro.

En el caso de los servidores de impresión, esta cadena es una de las cadenas predefinidas enumeradas en la sección Comentarios siguiente.

Tipo [in]

Código que indica el tipo de datos al que apunta el parámetro pData . Para obtener una lista de los posibles códigos de tipo, vea Tipos de valor del Registro.

pData [in]

Puntero a una matriz de bytes que contiene los datos de configuración de la impresora.

cbData [in]

Tamaño, en bytes, de la matriz.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto se ERROR_SUCCESS.

Si se produce un error en la función, el valor devuelto es un valor de error.

Comentarios

Nota:

Se trata de una función de bloqueo o sincrónica y podría no devolverse inmediatamente. La rapidez con la que devuelve esta función depende de factores en tiempo de ejecución, como el estado de red, la configuración del servidor de impresión y los factores de implementación de controladores de impresora que son difíciles de predecir al escribir una aplicación. Llamar a esta función desde un subproceso que administra la interacción con la interfaz de usuario podría hacer que la aplicación parezca que no responde.

Para recuperar los datos de configuración existentes para una impresora, llame a la función GetPrinterDataEx o GetPrinterData .

Si hPrinter es un identificador de un servidor de impresión, pValueName puede especificar uno de los siguientes valores predefinidos.

Value	Comentarios
SPLREG_ALLOW_USER_MANAGEFORMS	Windows XP con Service Pack 2 (SP2) y versiones posteriores Windows Server 2003 con Service Pack 1 (SP1) y versiones posteriores
SPLREG_BEEP_ENABLED
SPLREG_DEFAULT_SPOOL_DIRECTORY
SPLREG_EVENT_LOG
SPLREG_NET_POPUP	No se admite en Windows Server 2003 y versiones posteriores
SPLREG_PORT_THREAD_PRIORITY_DEFAULT
SPLREG_PORT_THREAD_PRIORITY
SPLREG_PRINT_DRIVER_ISOLATION_GROUPS	Windows 7 y versiones posteriores
SPLREG_PRINT_DRIVER_ISOLATION_TIME_BEFORE_RECYCLE	Windows 7 y versiones posteriores
SPLREG_PRINT_DRIVER_ISOLATION_MAX_OBJECTS_BEFORE_RECYCLE	Windows 7 y versiones posteriores
SPLREG_PRINT_DRIVER_ISOLATION_IDLE_TIMEOUT	Windows 7 y versiones posteriores
SPLREG_PRINT_DRIVER_ISOLATION_EXECUTION_POLICY	Windows 7 y versiones posteriores
SPLREG_PRINT_DRIVER_ISOLATION_OVERRIDE_POLICY	Windows 7 y versiones posteriores
SPLREG_RETRY_POPUP	Si el resultado es correcto, pData contiene 1 si el servidor está configurado para reintentar ventanas emergentes para todos los trabajos o 0 si el servidor no vuelve a intentar ventanas emergentes para todos los trabajos. No se admite en Windows Server 2003 y versiones posteriores
SPLREG_SCHEDULER_THREAD_PRIORITY
SPLREG_SCHEDULER_THREAD_PRIORITY_DEFAULT
SPLREG_WEBSHAREMGMT	Windows Server 2003 y versiones posteriores

Los siguientes valores de pValueName determinan el comportamiento de impresión del grupo cuando se produce un error.

Value	Comentarios
SPLREG_RESTART_JOB_ON_POOL_ERROR	El valor de pData indica el tiempo, en segundos, cuando se reinicia un trabajo en otro puerto después de producirse un error. Esta configuración se usa con SPLREG_RESTART_JOB_ON_POOL_ENABLED.
SPLREG_RESTART_JOB_ON_POOL_ENABLED	Un valor distinto de cero en pData indica que SPLREG_RESTART_JOB_ON_POOL_ERROR está habilitado.

El tiempo especificado en SPLREG_RESTART_JOB_ON_POOL_ERROR es un tiempo mínimo. El tiempo real puede ser más largo, según la siguiente configuración del monitor de puerto, que son valores del Registro en esta clave del Registro:

HKLM\SYSTEM\CurrentControlSet\Control\Print\Monitors\<MonitorName>\Ports

Llame a la función RegSetValueEx para establecer estos valores.

Configuración del monitor de puerto	Tipo de datos	Significado
StatusUpdateEnabled	REG_DWORD	Si es un valor distinto de cero, permite al monitor de puerto actualizar el administrador de colas con el estado del puerto.
StatusUpdateInterval	REG_DWORD	Especifica el intervalo, en minutos, cuando el monitor de puerto actualiza el administrador de colas con el estado del puerto.

En Windows 7 y versiones posteriores de Windows, los trabajos de impresión que se envían a un servidor de impresión se representan en el cliente de forma predeterminada. La representación del lado cliente de los trabajos de impresión se puede configurar para cada impresora estableciendo los valores siguientes en pValueName.

Configuración	Tipo de datos	Descripción
EMFDespoolingSetting	REG_DWORD	Un valor de 0, o si este valor no está presente en el Registro, habilita la representación predeterminada del lado cliente de los trabajos de impresión. Un valor de 1 deshabilita la representación del lado cliente de los trabajos de impresión.
ForceClientSideRendering	REG_DWORD	Un valor de 0, o si este valor no está presente en el Registro, hace que los trabajos de impresión se represente en el cliente. Si no se puede representar un trabajo de impresión en el cliente, se representará en el servidor. Si no se puede representar un trabajo de impresión en el servidor, se producirá un error. Un valor de 1 representará los trabajos de impresión en el cliente. Si no se puede representar un trabajo de impresión en el cliente, se producirá un error.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Encabezado	Winspool.h (incluye Windows.h)
Biblioteca	Winspool.lib
Archivo DLL	Winspool.drv
Nombres Unicode y ANSI	SetPrinterDataW (Unicode) y SetPrinterDataA (ANSI)

Consulte también

Impresión

Funciones de la API del administrador de trabajos de impresión

GetPrinter

GetPrinterData

GetPrinterDataEx

OpenPrinter

SetPrinterDataEx