Share via


Función EnumPrintProcessors

La función EnumPrintProcessors enumera los procesadores de impresión instalados en el servidor especificado.

Sintaxis

BOOL EnumPrintProcessors(
  _In_  LPTSTR  pName,
  _In_  LPTSTR  pEnvironment,
  _In_  DWORD   Level,
  _Out_ LPBYTE  pPrintProcessorInfo,
  _In_  DWORD   cbBuf,
  _Out_ LPDWORD pcbNeeded,
  _Out_ LPDWORD pcReturned
);

Parámetros

pName [in]

Puntero a una cadena terminada en null que especifica el nombre del servidor en el que residen los procesadores de impresión. Si este parámetro es NULL, se enumeran los procesadores de impresión locales.

pEnvironment [in]

Puntero a una cadena terminada en null que especifica el entorno (por ejemplo, Windows x86, Windows IA64 o Windows x64). Si este parámetro es NULL, se usa el entorno actual de la aplicación que realiza la llamada y la máquina cliente (no de la aplicación de destino y el servidor de impresión).

Nivel [in]

Tipo de información devuelta en el búfer pPrintProcessorInfo . Este parámetro debe ser 1.

pPrintProcessorInfo [out]

Puntero a un búfer que recibe una matriz de estructuras de PRINTPROCESSOR_INFO_1 . Cada estructura describe un procesador de impresión disponible. El búfer debe ser lo suficientemente grande como para recibir la matriz de estructuras y las cadenas a las que apuntan los miembros de la estructura.

Para determinar el tamaño de búfer necesario, llame a EnumPrintProcessors con cbBuf establecido en cero. Se produce un error en EnumPrintProcessors, GetLastError devuelve ERROR_INSUFFICIENT_BUFFER y el parámetro pcbNeeded devuelve el tamaño, en bytes, del búfer necesario para contener la matriz de estructuras y sus datos.

cbBuf [in]

Tamaño, en bytes, del búfer al que apunta pPrintProcessorInfo.

pcbNeeded [ out]

Puntero a una variable que recibe el número de bytes copiados en el búfer pPrintProcessorInfo si la función se realiza correctamente. Si el búfer es demasiado pequeño, se produce un error en la función y la variable recibe el número de bytes necesarios.

pcReturned [out]

Puntero a una variable que recibe el número de estructuras devueltas en el búfer pPrintProcessorInfo .

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es un valor distinto de cero.

Si la función no se realiza correctamente, el valor devuelto es cero.

Comentarios

Nota:

Se trata de una función de bloqueo o sincrónica que 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 del controlador 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.

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
EnumPrintProcessorsW (Unicode) y EnumPrintProcessorsA (ANSI)

Consulte también

Impresión

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

AddPrintProcessor

EnumPrintProcessorDatatypes

PRINTPROCESSOR_INFO_1