Método IXpsOMPackageWriter::StartNewDocument (xpsobjectmodel.h)

Artículo
08/28/2023

Abre e inicializa un nuevo FixedDocument en fixedDocumentSequence del paquete.

Sintaxis

HRESULT StartNewDocument(
  [in] IOpcPartUri                            *documentPartName,
  [in] IXpsOMPrintTicketResource              *documentPrintTicket,
  [in] IXpsOMDocumentStructureResource        *documentStructure,
  [in] IXpsOMSignatureBlockResourceCollection *signatureBlockResources,
  [in] IXpsOMPartUriCollection                *restrictedFonts
);

Parámetros

[in] documentPartName

Puntero a una interfaz IOpcPartUri que contiene el nombre de elemento del nuevo documento.

[in] documentPrintTicket

Puntero a una interfaz IXpsOMPrintTicketResource que contiene el vale de impresión de nivel de documento. Si no hay ningún vale de impresión de nivel de documento para este paquete, este parámetro se puede establecer en NULL. Vea también Comentarios.

[in] documentStructure

Puntero a una interfaz IXpsOMDocumentStructureResource que contiene el recurso de estructura de documento inicial, si el recurso está disponible; si no está disponible, este parámetro se puede establecer en NULL.

[in] signatureBlockResources

Puntero a una interfaz IXpsOMSignatureBlockResourceCollection que contiene una colección de firmas digitales que se van a adjuntar al documento. Si no hay firmas digitales que se van a adjuntar, este parámetro se puede establecer en NULL.

[in] restrictedFonts

Puntero a una interfaz IXpsOMPartUriCollection que contiene las fuentes que deben tener relaciones de fuente restringidas escritas para ellos. Los datos de fuente no se escriben hasta que se llama a AddResource o Close .

Si el documento no contiene ninguna fuente restringida, este parámetro se puede establecer en NULL.

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.
XPS_E_UNAVAILABLE_PACKAGE	Se produjo un error grave y es posible que el contenido del OM XPS no se pueda recuperar. Es posible que algunos componentes del OM XPS sigan siendo utilizables, pero solo después de que se hayan comprobado. Dado que el estado del OM XPS no se puede predecir después de que se devuelva este error, se deben liberar y descartar todos los componentes del OM XPS.
XPS_E_UNEXPECTED_RESTRICTED_FONT_RELATIONSHIP	La colección de fuentes restringidas pasada en restrictedFonts contiene una fuente sin restricciones.

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

Se debe llamar a este método antes de que se pueda llamar a AddPage para escribir el contenido de una interfaz IXpsOMPage .

Inmediatamente después de crear una instancia de la interfaz IXpsOMPackageWriter , el paquete solo contiene una parte vacía de secuencia de documentos fija. La primera vez que se llama a este método, se agrega una parte FixedDocument al elemento Fixed Document Sequence y el método AddPage agregará páginas a esa parte FixedDocument. Cada vez que se llama a este método después de la primera vez, se cierra la parte FixedDocument actual y se abre un nuevo elemento FixedDocument y se agrega al elemento De secuencia de documentos fijo. Todas las llamadas posteriores al método AddPage agregan páginas al elemento FixedDocument abierto más recientemente. Esta interfaz no admite la adición de páginas a elementos FixedDocument cerrados.

Si documentPrintTicket contiene un puntero NULL y el escritor de paquetes se creó con la intercalación establecida en XPS_INTERLEAVING_ON, este método crea un vale de impresión de nivel de documento en blanco, si aún no existe alguno. Cada vez que se llama a este método con un puntero NULL en documentPrintTicket, agrega una relación del nuevo documento al vale de impresión en blanco. Esto se hace para proporcionar un consumo de streaming más eficaz del paquete.

Si documentPrintTicket contiene un puntero NULL y el escritor de paquetes se creó con la intercalación establecida en XPS_INTERLEAVING_OFF, no se crea ningún vale de impresión en blanco.

Nota La creación de un documento en el paquete 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