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

Artigo
11/20/2024

Grava o pacote XPS em um arquivo especificado.

Sintaxe

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

Parâmetros

[in] fileName

O nome do arquivo a ser criado. Esse parâmetro não deve ser NULL.

[in] securityAttributes

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.

[in] flagsAndAttributes

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.

[in] optimizeMarkupSize

Um valor booliano que indica se a marcação do documento deve ser otimizada para o tamanho quando é gravada no arquivo.

Valor	Significado
VERDADEIRO	O gravador de pacote tentará otimizar a marcação para o tamanho mínimo.
FALSE	O gravador de pacotes não tentará nenhuma otimização.

Valor de retorno

O método retorna umHRESULT . Os valores possíveis incluem, mas não se limitam a, aqueles na tabela 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.

Código de retorno	Descrição
S_OK	O método foi bem-sucedido.
E_POINTER	fileName é NULL.

Esse método chama a API de de Empacotamento de . Para obter informações sobre os valores retornados da API de Empacotamento, consulte Erros de Empacotamento.

Observações

O valor optimizeMarkupSize determina se a marcação dentro das partes individuais do documento deve ser otimizada. Ele não tem efeito sobre como as partes são intercaladas.

Observação Gravar um OM XPS em um arquivo não cria automaticamente uma miniatura para o documento XPS. Para criar uma miniatura do documento XPS, use a interface IXpsOMThumbnailGenerator.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows 7, Windows Vista com SP2 e Atualização de Plataforma para Windows Vista [aplicativos da área de trabalho \| Aplicativos UWP]
servidor com suporte mínimo	Windows Server 2008 R2, Windows Server 2008 com SP2 e Atualização de Plataforma para Windows Server 2008 [aplicativos da área de trabalho \| Aplicativos UWP]
da Plataforma de Destino	Windows
cabeçalho	xpsobjectmodel.h