Método IXpsOMPackage1::WriteToFile1 (xpsobjectmodel_1.h)

Grava um OM XPS em um arquivo como um pacote XPS de um tipo especificado.

Sintaxe

HRESULT WriteToFile1(
  LPCWSTR               fileName,
  LPSECURITY_ATTRIBUTES securityAttributes,
  DWORD                 flagsAndAttributes,
  BOOL                  optimizeMarkupSize,
  XPS_DOCUMENT_TYPE     documentType
);

Parâmetros

fileName

[in, string] O nome do arquivo a ser criado. Esse parâmetro não deve ser NULL.

securityAttributes

[in, unique] A estrutura SECURITY_ATTRIBUTES, que contém dois membros de dados distintos, mas relacionados:

lpSecurityDescriptor: um descritor de segurança opcional

bInheritHandle: um valor booliano que determina se o identificador retornado pode ser herdado por processos filho

Se lpSecurityDescriptor for NULL, o arquivo ou dispositivo associado ao identificador retornado receberá um descritor de segurança padrão.

Para obter mais informações sobre o parâmetro securityAttributes, consulte CreateFile.

flagsAndAttributes

[in] Especifica as configurações e os atributos do arquivo a ser criado. Para a maioria dos arquivos, um valor de FILE_ATTRIBUTE_NORMAL pode ser usado.

Para obter mais informações sobre o parâmetro flagsAndAttributes, consulte CreateFile.

optimizeMarkupSize

[in] Um valor booliano que indica se a marcação do documento será otimizada para tamanho quando o conteúdo do OM XPS for gravado no pacote XPS.

TRUE: o gravador de pacote tentará otimizar a marcação para o tamanho mínimo.

FALSE: o gravador de pacote não tentará executar nenhuma otimização.

documentType

[in] O formato de dados XPS a ser gravado em outputStream. O valor desse parâmetro não pode ser XPS_DOCUMENT_TYPE_UNSPECIFIED.

Valor retornado

O método retorna um HRESULT. Os valores possíveis incluem, mas não se limitam a, os valores a seguir. Para obter informações sobre valores retornados da API de Documento XPS que não estão listados nesta tabela, consulte Erros de documento XPS.

S_OK: o método foi bem-sucedido.

E_POINTER: documentType é NULL.

E_INVALIDARG: o tipo de documento foi especificado como XPS_DOCUMENT_TYPE_UNSPECIFIED.

XPS_E_INVALID_CONTENT_TYPE: um recurso de imagem no pacote é de um tipo que não é compatível com o tipo de documento especificado em documentType.

Comentários

O chamador deve garantir que todos os recursos de imagem no pacote sejam compatíveis com o tipo de pacote. Por exemplo, as imagens JpegXR não podem ser usadas em um tipo de documento MSXPS porque são incompatíveis.

Requisitos

Confira também

IXpsOMPackage1