Drucken eines XPS-OM
Beschreibt, wie ein XPS-OM als XPS-Dokument an einen Drucker gesendet wird.
Anweisungen zum Drucken eines XPS-OM, das ein vollständiges XPS-Dokument enthält, finden Sie unter Drucken eines vollständigen XPS-OM. Um ein XPS-Dokument zu enthalten, muss ein XPS-OM die in Ein leeres XPS OM erstellen aufgeführten Elemente enthalten.
Anweisungen zum Drucken eines XPS-OM, das jeweils erstellt oder verarbeitet wird, finden Sie unter Inkrementelles Drucken eines XPS-OM.
Bevor Sie diese Codebeispiele in Ihrem Programm verwenden, lesen Sie den Haftungsausschluss in Allgemeine XPS-Dokumentprogrammierungsaufgaben.
In diesem Thema wird gezeigt, wie Sie die folgenden Aufgaben ausführen:
Drucken eines vollständigen XPS-OM
Wenn ein XPS-OM ein vollständiges XPS-Dokument enthält, kann die WriteToStream-Methode der IXpsOMPackage-Schnittstelle den Inhalt des XPS-OM an einen Drucker oder eine Druckwarteschlange senden.
Um zu erkennen, wann der Druckauftrag abgeschlossen wurde, erstellen Sie wie im folgenden Beispiel gezeigt ein Ereignishandle.
HANDLE completionEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
if (NULL == completionEvent)
{
hr = HRESULT_FROM_WIN32(GetLastError());
// The method can continue, but print spooling completion
// cannot be checked without a valid event handle.
}
So drucken Sie ein vollständiges XPS-OM:
- Erstellen Sie einen neuen Druckauftragsstream, indem Sie StartXpsPrintJob aufrufen.
- Senden Sie den Inhalt des XPS-OM an den Datenstrom, indem Sie die WriteToStream -Methode des Pakets aufrufen.
- Schließen Sie den Druckauftragsdatenstrom, indem Sie die Schließen-Methode des Datenstroms aufrufen.
- Warten Sie auf das Signal, dass der Druckauftrag abgeschlossen ist.
- Überprüfen Sie den Beendigungsstatus.
- Schließen und Freigeben von Ressourcen.
IXpsPrintJob *job = NULL;
IXpsPrintJobStream *jobStream = NULL;
hr = StartXpsPrintJob(
printerName,
NULL,
NULL,
NULL,
completionEvent,
NULL,
0,
&job,
&jobStream,
NULL);
// Write package to print job stream
hr = package->WriteToStream (jobStream, FALSE);
// Close the stream to tell the print job
// that the entire document has been sent.
hr = jobStream->Close();
// Wait for the print job to finish spooling...
if (NULL != completionEvent) {
if (WaitForSingleObject(completionEvent, INFINITE) == WAIT_OBJECT_0)
{
// Get the print job status to see why the wait completed.
// Note that without waiting for a completion event,
// the print job may not be complete when the status is queried.
XPS_JOB_STATUS jobStatus;
hr = job->GetJobStatus(&jobStatus);
// Evaluate the job status returned.
switch (jobStatus.completion)
{
case XPS_JOB_COMPLETED:
// The job completed as expected.
hr = S_OK;
break;
case XPS_JOB_CANCELLED:
// The job was canceled.
hr = E_FAIL;
break;
case XPS_JOB_FAILED:
// The job failed,
// jobStatus.jobStatus has the reason.
hr = E_FAIL;
break;
default:
// An unexpected value was returned.
hr = E_UNEXPECTED;
break;
}
// Release completion event handle
CloseHandle(completionEvent);
}
else
{ // there was a problem, set hr to error status
hr = HRESULT_FROM_WIN32(GetLastError());
}
}
// hr contains the result of the print operation
CoUninitialize(); // if COM is no longer needed in this thread
Inkrementelles Drucken eines XPS-OM
Sie können die Dokumentkomponenten eines XPS OM inkrementell an einen Druckerauftrag senden, indem Sie einen XPS-Druckauftragsstream erstellen und dann die einzelnen Dokumentkomponenten einzeln an den Druckauftragsstream übergeben. Die Reihenfolge, in der die Dokumentkomponenten gesendet werden, bestimmt, wie sie im fertigen Dokument angezeigt werden. Damit ein Programm den Code in diesem Beispiel aufrufen kann, muss es die Dokumentkomponenten ordnungsgemäß organisieren.
Bevor Sie XPS OM-Schnittstellen verwenden, initialisieren Sie COM im Thread wie im folgenden Beispielcode dargestellt.
HRESULT hr;
hr = CoInitializeEx(NULL, COINIT_MULTITHREADED);
Um den Abschluss des Druckauftrags zu überwachen, erstellen Sie wie im folgenden Beispielcode gezeigt ein Ereignishandle.
HANDLE completionEvent = NULL;
completionEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
if (NULL == completionEvent)
{
hr = HRESULT_FROM_WIN32(GetLastError());
// The method can continue, but print spooling completion
// cannot be checked without a valid event handle.
}
Erstellen Sie einen neuen Druckauftragsstream und einen neuen Paketschreiber. Übergeben Sie die einzelnen Dokumentkomponenten an die entsprechenden Package Writer-Methoden in derselben Reihenfolge wie im fertigen Dokument.
Beginnen Sie jedes Dokument neu und fügen Sie ihm dann Seiten hinzu. Nachdem sie alle Dokumentkomponenten an den Druckauftragsstream übergeben haben, schließen Sie den Datenstrom, warten Sie, bis der Druckauftrag abgeschlossen ist und schließen und geben Sie dann geöffnete Ressourcen frei.
- Erstellen Sie einen neuen Druckauftragsstream, indem Sie StartXpsPrintJob aufrufen.
- Erstellen Sie einen Teil-URI für den FixedDocumentSequence-Teil.
- Erstellen Sie einen neuen Paket-Writer im Druckauftragsstream.
- Für jedes Dokument, das geschrieben werden soll:
- Erstellen Sie einen neuen Teil-URI für den FixedDocument-Teil.
- Starten Sie ein neues Dokument im Paketschreiber.
- Erstellen Sie für jede Seite im aktuellen Dokument einen Teil-URI für den FixedPage-Teil und fügen Sie die Seite zum Paketschreiber hinzu.
- Nachdem alle Seiten dem Paketschreiber hinzugefügt wurden, schließen Sie diesen.
- Schließen Sie den Druckauftragsdatenstrom.
- Warten Sie, bis der Druckauftrag abgeschlossen ist.
- Überprüfen Sie den Beendigungsstatus.
- Schließen sie geöffnete Ressourcen und geben Sie sie frei.
IXpsPrintJob* job = NULL;
IXpsPrintJobStream* jobStream = NULL;
hr = StartXpsPrintJob(
argv[1],
NULL,
NULL,
NULL,
completionEvent,
NULL,
0,
&job,
&jobStream,
NULL);
// Note the implicit requirement that CoInitializeEx
// has previously been called from this thread.
IXpsOMObjectFactory *xpsFactory = NULL;
hr = CoCreateInstance(
__uuidof(XpsOMObjectFactory),
NULL,
CLSCTX_INPROC_SERVER,
__uuidof(IXpsOMObjectFactory),
reinterpret_cast<void**>(&xpsFactory)
);
// Create part URI for FixedDocumentSequence part
// This can use a static string because there is only one
// FixedDocumentSequence part in the print job.
IOpcPartUri *partUri = NULL;
hr = xpsFactory->CreatePartUri(L"/FixedDocumentSequence.fdseq", &partUri);
// Create the package writer on the print job stream
// Note that the interleaving parameter set to
// XPS_INTERLEAVING_ON, the package writer will create
// empty print ticket parts when a NULL pointer is
// passed in the print ticket argument of this method,
// the StartNewDocument method, and the AddPage method.
// For more information, see the help for these methods.
IXpsOMPackageWriter *packageWriter = NULL;
hr = xpsFactory->CreatePackageWriterOnStream(
jobStream,
TRUE,
XPS_INTERLEAVING_ON, // to create blank print ticket objects
partUri,
NULL,
NULL,
NULL,
NULL,
&packageWriter);
// release partUri after it's been used to create new doc. seq.
if (partUri)
{
partUri->Release();
partUri = NULL;
}
// Add document content to the print job stream.
int docNumber = 1;
int docsInPackage = 1; // Change this value as required.
while (docNumber <= docsInPackage) {
// Create a unique part URI for the current document.
WCHAR DocPartUri[MAX_PATH];
hr = MakeDocumentPartUri (docNumber, MAX_PATH, DocPartUri);
hr = xpsFactory->CreatePartUri(DocPartUri, &partUri);
// Initialize the new document in the package writer.
hr = packageWriter->StartNewDocument(partUri, NULL, NULL, NULL, NULL);
// release part URI after it's been used to create new doc.
if (partUri)
{
partUri->Release();
partUri = NULL;
}
// Add the pages
int pageNumber = 1;
int pagesInDocument = 1; // Change this value as required.
while (pageNumber <= pagesInDocument) {
// Create a unique part URI for the current page
WCHAR PagePartUri[MAX_PATH];
hr = MakePagePartUri (
docNumber,
pageNumber,
MAX_PATH,
PagePartUri);
hr = xpsFactory->CreatePartUri(PagePartUri, &partUri);
// create page in OM
XPS_SIZE pageSize = {816, 1056};
IXpsOMPage *xpsPage = NULL;
hr = xpsFactory->CreatePage(
&pageSize,
L"en-US",
partUri,
&xpsPage);
// release pagePartUri after it's been used to create the page
if (partUri)
{
partUri->Release();
partUri = NULL;
}
// add content to the page or retrieve
// the page from the XPS OM.
// (not shown in this example)
// add page to document
hr = packageWriter->AddPage(
xpsPage,
&pageSize,
NULL,
NULL,
NULL,
NULL);
if (xpsPage)
{
xpsPage->Release();
xpsPage = NULL;
}
// go to the next page
pageNumber++;
}
// the fixed document does not need to be closed.
// it will be closed when a new fixed doc is opened
// or the package is closed.
// go to the next document
docNumber++;
}
// Close the package writer when finished
hr = packageWriter->Close();
if (SUCCEEDED(hr))
{
// Close the print stream to tell the print
// job that the all document contents have
// been sent
hr = jobStream->Close();
// Wait for the print job to finish spooling...
if (NULL != completionEvent) {
if (WaitForSingleObject(completionEvent, INFINITE) == WAIT_OBJECT_0)
{
// Get the print job status to see why the wait completed.
// Note that without waiting for a completion event,
// the print job may not be complete when the status is queried.
XPS_JOB_STATUS jobStatus;
hr = job->GetJobStatus(&jobStatus);
// Evaluate the job status returned.
switch (jobStatus.completion)
{
case XPS_JOB_COMPLETED:
// The job completed as expected.
hr = S_OK;
break;
case XPS_JOB_CANCELLED:
// The job was canceled.
hr = E_FAIL;
break;
case XPS_JOB_FAILED:
// The job failed,
// jobStatus.jobStatus has the reason.
hr = E_FAIL;
break;
default:
// An unexpected value was returned.
hr = E_UNEXPECTED;
break;
}
// Release completion event handle
CloseHandle(completionEvent);
}
else
{ // there was a problem, set hr to error status
hr = HRESULT_FROM_WIN32(GetLastError());
}
}
}
else
{
// cancel the job, if one exists, because
// the close call returned an error
if (job) job->Cancel();
}
// hr contains the result of the print operation
// free/release pointers and handles used.
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;
}
CoUninitialize(); // If done with COM in this thread.
Wenn das Programm die Dokumentkomponenten inkrementell schreibt, wie in diesem Beispiel gezeigt, muss es die Teilenamen für jeden Dokumentteil generieren, den es an den Druckauftragsstream sendet. Im vorherigen Beispiel wird der FixedDocumentSequence-Teil-URI aus einer statischen Zeichenfolge erstellt, da es nur einen solchen Teil im XPS-Dokument gibt. Der URI jeder FixedPage- und FixedDocument-Komponente muss innerhalb des XPS-Dokuments eindeutig sein. Durch das Erstellen des Teil-URI mithilfe des Indexes dieser Komponenten kann sichergestellt werden, dass die resultierende URI-Zeichenfolge innerhalb des XPS-Dokuments eindeutig ist.
HRESULT MakeDocumentPartUri (
__in int docNumber,
__in DWORD partUriStringLength,
__inout LPWSTR partUriStringBuffer
)
{
// create a Part URI string using the document number
// that was passed as an argument
// for example, "/Documents/1/FixedDocument.fdoc"
// where "1" specifies the document number, which would
// change with each document printed
return S_OK;
}
HRESULT MakePagePartUri (
__in int docNumber,
__in int pageNumber,
__in DWORD partUriStringLength,
__inout LPWSTR partUriStringBuffer
)
{
// create a Part URI string using the document number
// and page number that were passed as an argument
// for example: "/Documents/1/Pages/1.fpage"
// where the first "1" between Documents and Pages
// specifies the document number, which would change with
// each document. The second "1" specifies the page number,
// which would change with each page in the document.
return S_OK;
}
Weitere Informationen zur Struktur eines XPS-Dokuments finden Sie in der XML Paper Specification.
Zugehörige Themen
-
Nächste Schritte
-
In diesem Abschnitt verwendet
-
Weitere Informationen
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für