Метод IXpsOMPackage1::WriteToFile1 (xpsobjectmodel_1.h)
Записывает OM XPS в файл в виде пакета XPS указанного типа.
Синтаксис
HRESULT WriteToFile1(
LPCWSTR fileName,
LPSECURITY_ATTRIBUTES securityAttributes,
DWORD flagsAndAttributes,
BOOL optimizeMarkupSize,
XPS_DOCUMENT_TYPE documentType
);
Параметры
fileName
[in, string] Имя создаваемого файла. Этот параметр не должен иметь значение NULL.
securityAttributes
[in, unique] Структура SECURITY_ATTRIBUTES, которая содержит два разных, но связанных элемента данных:
lpSecurityDescriptor: необязательный дескриптор безопасности.
bInheritHandle: логическое значение, определяющее, может ли возвращенный дескриптор наследоваться дочерними процессами.
Если lpSecurityDescriptor имеет значение NULL, файлу или устройству, связанному с возвращенным дескриптором, будет назначен дескриптор безопасности по умолчанию.
Дополнительные сведения о параметре securityAttributes см. в разделе CreateFile.
flagsAndAttributes
[in] Задает параметры и атрибуты создаваемого файла. Для большинства файлов можно использовать значение FILE_ATTRIBUTE_NORMAL.
Дополнительные сведения о параметре flagsAndAttributes см. в разделе CreateFile.
optimizeMarkupSize
[in] Логическое значение, указывающее, будет ли разметка документа оптимизирована для размера при записи содержимого XPS OM в пакет XPS.
TRUE. Модуль записи пакетов попытается оптимизировать разметку для минимального размера.
FALSE. Модуль записи пакетов не будет пытаться выполнить какую-либо оптимизацию.
documentType
[in] Формат данных XPS для записи в outputStream. Значение этого параметра не может быть XPS_DOCUMENT_TYPE_UNSPECIFIED.
Возвращаемое значение
Метод возвращает HRESULT. Возможные значения включают, помимо прочего, следующие значения. Сведения о возвращаемых значениях API документов XPS, не перечисленных в этой таблице, см. в разделе Ошибки документа XPS.
S_OK: метод выполнен успешно.
E_POINTER: documentType имеет значение NULL.
E_INVALIDARG: тип документа был указан как XPS_DOCUMENT_TYPE_UNSPECIFIED.
XPS_E_INVALID_CONTENT_TYPE. Ресурс изображения в пакете имеет тип, который не поддерживается типом документа, указанным в documentType.
Комментарии
Вызывающий объект должен убедиться, что все ресурсы образов в пакете поддерживаются типом пакета. Например, изображения JpegXR нельзя использовать в типе документов MSXPS, так как они несовместимы.
Требования
| Минимальная версия клиента | Windows 8 [классические приложения | Приложения UWP] |
| Минимальная версия сервера | Windows Server 2012 [классические приложения | Приложения UWP] |
| Целевая платформа | Windows |
| Header | xpsobjectmodel_1.h |
| Библиотека | Нет |