Método IXpsOMPackage::WriteToFile (xpsobjectmodel.h)

Artículo
12/22/2023

Escribe el paquete XPS en un archivo especificado.

Sintaxis

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

Parámetros

[in] fileName

Nombre del archivo que se va a crear. Este parámetro no debe ser NULL.

[in] securityAttributes

La estructura SECURITY_ATTRIBUTES , que contiene dos miembros de datos distintos pero relacionados:

lpSecurityDescriptor: un descriptor de seguridad opcional
bInheritHandle: un valor booleano que determina si los procesos secundarios pueden heredar el identificador devuelto.

Si lpSecurityDescriptor es NULL, al archivo o dispositivo asociado al identificador devuelto se le asignará un descriptor de seguridad predeterminado.

Para obtener más información sobre el parámetro securityAttributes , consulte CreateFile.

[in] flagsAndAttributes

Especifica la configuración y los atributos del archivo que se van a crear. Para la mayoría de los archivos, se puede usar un valor de FILE_ATTRIBUTE_NORMAL .

Para obtener más información sobre el parámetro flagsAndAttributes , consulte CreateFile.

[in] optimizeMarkupSize

Valor booleano que indica si el marcado de documento se va a optimizar para el tamaño cuando se escribe en el archivo.

Valor	Significado
VERDAD	El escritor de paquetes intentará optimizar el marcado para el tamaño mínimo.
FALSO	El escritor de paquetes no intentará ninguna optimización.

Valor devuelto

El método devuelve un valor HRESULT. Entre los valores posibles se incluyen, entre otros, los de la tabla siguiente. Para obtener información sobre los valores devueltos de la API de documentos XPS que no aparecen en esta tabla, vea Errores del documento XPS.

Código devuelto	Descripción
S_OK	El método se ha llevado a cabo de forma correcta.
E_POINTER	fileName es NULL.

Este método llama a packaging API. Para obtener información sobre los valores devueltos de la API de empaquetado, consulte Errores de empaquetado.

Comentarios

El valor optimizeMarkupSize determina si el marcado dentro de los elementos de documento individuales se va a optimizar. No tiene ningún efecto sobre cómo se intercalan las piezas.

Nota La escritura de un OM XPS en un archivo no crea automáticamente una miniatura para el documento XPS. Para crear una miniatura del documento XPS, use la interfaz IXpsOMThumbnailGenerator .

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 7, Windows Vista con SP2 y Platform Update para Windows Vista [aplicaciones de escritorio \| Aplicaciones para UWP]
Servidor mínimo compatible	Windows Server 2008 R2, Windows Server 2008 con SP2 y Actualización de plataforma para Windows Server 2008 [aplicaciones de escritorio \| Aplicaciones para UWP]
Plataforma de destino	Windows
Encabezado	xpsobjectmodel.h