Cómo: Imprimir con la API de impresión XPS
En este tema se describe cómo usar la API de impresión XPS para imprimir desde una aplicación de Windows.
La API de impresión XPS permite que las aplicaciones nativas de Windows impriman documentos XPS. Una aplicación puede crear un documento XPS mediante la API de documentos XPS. En el tema de ayuda Common XPS Document Programming Tasks se describe cómo hacerlo. Una vez creado un documento XPS, la aplicación puede usar XPS Print API para imprimirlo.
El uso de XPS Print API para imprimir un documento desde una aplicación implica los pasos siguientes.
- Inicializar interfaz COM
- Crear un evento de finalización
- Iniciar un trabajo de impresión XPS
- Crear una interfaz IXpsOMPackageWriter
- Cierre la interfaz IXpsOMPackageWriter
- Cierre el flujo del trabajo de impresión
- Esperar al evento de finalización
- Recursos de versión
La API de impresión XPS requiere que se imprima un documento XPS. En el ejemplo siguiente, el documento XPS se crea a medida que se envía a la impresora mediante XPS Print API. También es posible crear un documento XPS sin enviarlo a una impresora mediante la API de documentos XPS y mantenerlo como UN OM XPS o guardando el XPS OM como documento XPS. Para obtener más información sobre el uso de un OM XPS, consulte la API de documentos XPS.
Inicializar interfaz COM
Inicialice la interfaz COM, si la aplicación aún no lo ha hecho.
// Initialize the COM interface, if the application has not
// already done so.
if (FAILED(hr = CoInitializeEx(0, COINIT_MULTITHREADED)))
{
fwprintf(stderr,
L"ERROR: CoInitializeEx failed with HRESULT 0x%X\n", hr);
return 1;
}
Crear un evento de finalización
Cree un evento de finalización, que xpS Print API usa para notificar a la aplicación cuando el administrador de trabajos de impresión haya recibido todo el documento de la aplicación. XpS Print API también admite un evento de progreso para que una aplicación pueda conocer otras actividades de cola.
// Create the completion event
completionEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
if (!completionEvent)
{
hr = HRESULT_FROM_WIN32(GetLastError());
fwprintf(stderr,
L"ERROR: Could not create completion event: %08X\n", hr);
}
Iniciar un trabajo de impresión XPS
Inicie un trabajo de impresión XPS llamando a StartXpsPrintJob. StartXpsPrintJob devuelve una secuencia en la que la aplicación enviará el documento que se va a imprimir.
// Start an XPS Print Job
if (FAILED(hr = StartXpsPrintJob(
printerName,
NULL,
NULL,
NULL,
completionEvent,
NULL,
0,
&job,
&jobStream,
NULL
)))
{
fwprintf(stderr,
L"ERROR: Could not start XPS print job: %08X\n", hr);
}
Crear una interfaz IXpsOMPackageWriter
Cree una interfaz IXpsOMPackageWriter llamando a IXpsOMObjectFactory::CreatePackageWriterOnStream en la secuencia devuelta por StartXpsPrintJob.
// Create an XPS OM Object Factory. If one has already been
// created by the application, a new one is not necessary.
if (SUCCEEDED(hr))
{
if (FAILED(hr = CoCreateInstance(
__uuidof(XpsOMObjectFactory),
NULL,
CLSCTX_INPROC_SERVER,
IID_PPV_ARGS(&xpsFactory))))
{
fwprintf(
stderr,
L"ERROR: Could not create XPS OM Object Factory: %08X\n",
hr);
}
}
// Create the Part URI for the Fixed Document Sequence. The
// Fixed Document Sequence is the top-level element in the
// package hierarchy of objects. There is one Fixed Document
// Sequence in an XPS document.
//
// The part name is not specified by the XML Paper Specification,
// however, the name used in this example is the part name
// used by convention.
//
if (SUCCEEDED(hr))
{
if (FAILED(hr = xpsFactory->CreatePartUri(
L"/FixedDocumentSequence.fdseq",
&partUri)))
{
fwprintf(stderr,
L"ERROR: Could not create part URI: %08X\n", hr);
}
}
// Create the package writer on the print job stream.
if (SUCCEEDED(hr))
{
if (FAILED(hr = xpsFactory->CreatePackageWriterOnStream(
jobStream,
TRUE,
XPS_INTERLEAVING_ON,
partUri,
NULL,
NULL,
NULL,
NULL,
&packageWriter
)
)
)
{
fwprintf(
stderr,
L"ERROR: Could not create package writer: 0x%X\n",
hr);
}
}
// Release the part URI interface.
if (partUri)
{
partUri->Release();
partUri = NULL;
}
Para cada documento de este trabajo de impresión, inicie un nuevo documento y agregue páginas a ese documento.
Iniciar un nuevo documento
Inicie un nuevo documento en el escritor de paquetes llamando a IXpsOMPackageWriter::StartNewDocument. Si se abre un documento cuando se llama a este método, se cierra y se abre un nuevo documento.
// Create the Part URI for the Fixed Document. The
// Fixed Document part contains the pages of the document.
// There can be one or more Fixed Documents in an XPS document.
//
// The part name is not specified by the XML Paper Specification,
// however, the name format used in this example is the format
// used by convention. The number "1" in this example must be
// changed for each document in the package. For example, 1
// for the first document, 2 for the second, and so on.
//
if (SUCCEEDED(hr))
{
if (FAILED(hr = xpsFactory->CreatePartUri(
L"/Documents/1/FixedDocument.fdoc",
&partUri)))
{
fwprintf(
stderr,
L"ERROR: Could not create part URI: %08X\n",
hr);
}
}
// Start the new document.
//
// If there was already a document started in this page,
// this call will close it and start a new one.
if (SUCCEEDED(hr))
{
if (FAILED(hr = packageWriter->StartNewDocument(
partUri,
NULL,
NULL,
NULL,
NULL)))
{
fwprintf(
stderr,
L"ERROR: Could not start new document: 0x%X\n",
hr);
}
}
// Release the part URI interface
if (partUri)
{
partUri->Release();
partUri = NULL;
}
Agregar una página
Llame a IXpsOMPackageWriter::AddPage para escribir cada una de las páginas del documento desde la aplicación al nuevo documento en el escritor de paquetes.
Nota
Se supone que la aplicación ha creado la página antes de este paso. Para obtener más información sobre cómo crear páginas de documentos y agregar contenido a ellas, vea Common XPS Document Programming Tasks.
if (SUCCEEDED(hr))
{
// Add the current page to the document.
if (FAILED(hr = packageWriter->AddPage(
xpsPage,
&pageSize,
NULL,
NULL,
NULL,
NULL
)))
{
fwprintf(
stderr,
L"ERROR: Could not add page to document: %08X\n",
hr);
}
}
Cierre la interfaz IXpsOMPackageWriter
Una vez escritos todos los documentos para este trabajo de impresión, llame a IXpsOMPackageWriter::Close para cerrar el paquete.
if (SUCCEEDED(hr))
{
if (FAILED(hr = packageWriter->Close()))
{
fwprintf(
stderr,
L"ERROR: Could not close package writer: %08X\n",
hr);
}
}
Cierre el flujo del trabajo de impresión
Cierre el flujo del trabajo de impresión llamando a Close, que indica al administrador de trabajos de impresión que la aplicación ha enviado todo el trabajo de impresión.
if (SUCCEEDED(hr))
{
if (FAILED(hr = jobStream->Close()))
{
fwprintf(
stderr,
L"ERROR: Could not close job stream: %08X\n",
hr);
}
}
else
{
// Only cancel the job if we succeeded in creating a job.
if (job)
{
// Tell the XPS Print API that we're giving up.
// Don't overwrite hr with the return from this function.
job->Cancel();
}
}
Esperar al evento de finalización
Espere al evento de finalización del trabajo de impresión.
if (SUCCEEDED(hr))
{
wprintf(L"Waiting for job completion...\n");
if (WaitForSingleObject(completionEvent, INFINITE) !=
WAIT_OBJECT_0)
{
hr = HRESULT_FROM_WIN32(GetLastError());
fwprintf(
stderr,
L"ERROR: Wait for completion event failed: %08X\n",
hr);
}
}
Una vez señalado el evento de finalización, llame a GetJobStatus para obtener el estado del trabajo.
if (SUCCEEDED(hr))
{
if (FAILED(hr = job->GetJobStatus(&jobStatus)))
{
fwprintf(
stderr,
L"ERROR: Could not get job status: %08X\n",
hr);
}
}
if (SUCCEEDED(hr))
{
switch (jobStatus.completion)
{
case XPS_JOB_COMPLETED:
break;
case XPS_JOB_CANCELLED:
fwprintf(stderr, L"ERROR: job was cancelled\n");
hr = E_FAIL;
break;
case XPS_JOB_FAILED:
fwprintf(
stderr,
L"ERROR: Print job failed: %08X\n",
jobStatus.jobStatus);
hr = E_FAIL;
break;
default:
fwprintf(stderr, L"ERROR: unexpected failure\n");
hr = E_UNEXPECTED;
break;
}
}
Liberación de recursos
Después de que un estado de trabajo indique la finalización, libere las interfaces y los recursos usados para este trabajo de impresión.
if (packageWriter)
{
packageWriter->Release();
packageWriter = NULL;
}
if (partUri)
{
partUri->Release();
partUri = NULL;
}
if (xpsFactory)
{
xpsFactory->Release();
xpsFactory = NULL;
}
if (jobStream)
{
jobStream->Release();
jobStream = NULL;
}
if (job)
{
job->Release();
job = NULL;
}
if (completionEvent)
{
CloseHandle(completionEvent);
completionEvent = NULL;
}