Метод IXpsOMPackage::WriteToFile (xpsobjectmodel.h)

Статья
11/20/2024

Записывает пакет XPS в указанный файл.

Синтаксис

HRESULT WriteToFile(
  [in] LPCWSTR               fileName,
  [in] LPSECURITY_ATTRIBUTES securityAttributes,
  [in] DWORD                 flagsAndAttributes,
  [in] BOOL                  optimizeMarkupSize
);

Параметры

[in] fileName

Имя создаваемого файла. Этот параметр не должен быть null.

[in] securityAttributes

Структура SECURITY_ATTRIBUTES, которая содержит два отдельных, но связанных элементов данных:

lpSecurityDescriptor: необязательный дескриптор безопасности
bInheritHandle: логическое значение, определяющее, может ли возвращаемый дескриптор наследоваться дочерними процессами.

Если lpSecurityDescriptor NULL, файл или устройство, связанное с возвращенным дескриптором безопасности, будет назначен дескриптор безопасности по умолчанию.

Дополнительные сведения о параметре securityAttributes см. в статье CreateFile.

[in] flagsAndAttributes

Указывает параметры и атрибуты создаваемого файла. Для большинства файлов можно использовать значение FILE_ATTRIBUTE_NORMAL.

Дополнительные сведения о параметре флагов AndAttributes см. в разделе CreateFile.

[in] optimizeMarkupSize

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

Ценность	Значение
TRUE	Модуль записи пакетов попытается оптимизировать разметку для минимального размера.
FALSE	Модуль записи пакетов не будет пытаться выполнить оптимизацию.

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

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

Возвращаемый код	Описание
S_OK	Метод выполнен успешно.
E_POINTER	fileNameNULL.

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

Замечания

Значение optimizeMarkupSize определяет, следует ли оптимизировать разметку внутри отдельных частей документа. Это не влияет на то, как части перемешиваются.

Заметка записи OM XPS в файл не создает эскиз для документа XPS. Чтобы создать эскиз документа XPS, используйте интерфейс IXpsOMThumbnailGenerator.

Требования

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