Метод IXpsOMObjectFactory::CreatePackageWriterOnStream (xpsobjectmodel.h)

Статья
03/05/2024

Открывает поток для записи содержимого XPS OM в пакет XPS.

Синтаксис

HRESULT CreatePackageWriterOnStream(
  [in]          ISequentialStream         *outputStream,
  [in]          BOOL                      optimizeMarkupSize,
  [in]          XPS_INTERLEAVING          interleaving,
  [in]          IOpcPartUri               *documentSequencePartName,
  [in]          IXpsOMCoreProperties      *coreProperties,
  [in]          IXpsOMImageResource       *packageThumbnail,
  [in]          IXpsOMPrintTicketResource *documentSequencePrintTicket,
  [in]          IOpcPartUri               *discardControlPartName,
  [out, retval] IXpsOMPackageWriter       **packageWriter
);

Параметры

[in] outputStream

Поток, используемый для записи.

[in] optimizeMarkupSize

Логическое значение, указывающее, будет ли разметка документа оптимизирована для размера при записи документа в поток.

Значение	Значение
ИСТИННЫЙ	При записи в поток модуль записи пакетов попытается оптимизировать разметку для минимального размера.
ЛОЖНЫХ	При записи в пакет модуль записи пакетов не будет пытаться выполнить оптимизацию.

[in] interleaving

Указывает, будет ли содержимое XPS OM чередоваться при записи в поток.

[in] documentSequencePartName

Интерфейс IOpcPartUri , содержащий имя части последовательности документов в новом файле.

[in] coreProperties

Интерфейс IXpsOMCoreProperties , содержащий основные свойства документа, которые необходимо присвоить новому файлу. Для этого параметра можно задать значение NULL.

[in] packageThumbnail

Интерфейс IXpsOMImageResource , содержащий эскиз изображения, который будет назначен новому файлу. Для этого параметра можно задать значение NULL.

[in] documentSequencePrintTicket

Интерфейс IXpsOMPrintTicketResource , содержащий билет печати на уровне пакета для назначения новому файлу. Для этого параметра можно задать значение NULL.

[in] discardControlPartName

Интерфейс IOpcPartUri , содержащий имя части элемента управления "Отменить". Для этого параметра можно задать значение NULL.

[out, retval] packageWriter

Указатель на новый интерфейс IXpsOMPackageWriter , созданный этим методом.

Возвращаемое значение

Метод возвращает HRESULT. Возможные значения включают, помимо прочего, значения в следующей таблице. Сведения о возвращаемых значениях API документов XPS, не перечисленных в этой таблице, см. в разделе Ошибки документа XPS.

Код возврата	Описание
S_OK	Метод выполнен успешно.
E_POINTER	outputStream, documentSequencePartName или packageWriter имеет значение NULL.
XPS_E_NO_CUSTOM_OBJECTS	coreProperties, documentSequencePrintTicket или packageThumbnail не указывают на реализацию распознанного интерфейса. Пользовательская реализация интерфейсов API документов XPS не поддерживается.

Этот метод вызывает API упаковки . Сведения о возвращаемых значениях API упаковки см. в разделе Ошибки упаковки.

Поток открывается и инициализируется, а затем возвращенный интерфейс IXpsOMPackageWriter используется для записи типов контента, связей пакетов, основных свойств, ресурсов последовательности документов и связей последовательностей документов.

Если параметру documentSequencePrintTicket присвоено значение NULL , а значение чередованияравно XPS_INTERLEAVING_ON, этот метод создает пустой билет печати на уровне задания и добавляет связь с пустым билетом печати. Это делается для более эффективного использования пакета потоковой передачи.

Если параметру documentSequencePrintTicket присвоено значение NULL , а значение чередованияравно XPS_INTERLEAVING_OFF, пустой билет печати не создается.

Требования

Требование	Значение
Минимальная версия клиента	Windows 7, Windows Vista с пакетом обновления 2 (SP2) и обновление платформы для Windows Vista [классические приложения \| Приложения UWP]
Минимальная версия сервера	Windows Server 2008 R2, Windows Server 2008 с пакетом обновления 2 (SP2) и Обновление платформы для Windows Server 2008 [классические приложения \| Приложения UWP]
Целевая платформа	Windows
Header	xpsobjectmodel.h