Método IXpsOMObjectFactory1::CreatePackageWriterOnFile1 (xpsobjectmodel_1.h)

Artigo
11/20/2024

Abre um arquivo para gravar o conteúdo de um OM XPS em um pacote XPS de um tipo especificado. Esse método produz um gravador de pacotes para um documento MSXPS ou um documento OpenXPS.

Sintaxe

HRESULT CreatePackageWriterOnFile1(
  LPCWSTR                   fileName,
  LPSECURITY_ATTRIBUTES     securityAttributes,
  DWORD                     flagsAndAttributes,
  BOOL                      optimizeMarkupSize,
  XPS_INTERLEAVING          interleaving,
  IOpcPartUri               *documentSequencePartName,
  IXpsOMCoreProperties      *coreProperties,
  IXpsOMImageResource       *packageThumbnail,
  IXpsOMPrintTicketResource *documentSequencePrintTicket,
  IOpcPartUri               *discardControlPartName,
  XPS_DOCUMENT_TYPE         documentType,
  IXpsOMPackageWriter       **packageWriter
);

Parâmetros

fileName

[in] O nome do arquivo a ser criado.

securityAttributes

[in, unique] A estrutura SECURITY_ATTRIBUTES, que contém dois membros separados, 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 recebe um descritor de segurança padrão.

Para obter mais informações sobre securityAttributes, consulte CreateFile.

flagsAndAttributes

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

Consulte CreateFile para obter mais informações sobre esse parâmetro.

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.

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á executar nenhuma otimização.

interleaving

[in] Especifica se o conteúdo do OM XPS será intercalado quando ele for gravado no arquivo.

documentSequencePartName

[in] A interface IOpcPartUri que contém o nome da parte da sequência de documentos no novo arquivo.

coreProperties

[in] A interface IXpsOMCoreProperties que contém as principais propriedades do documento a serem fornecidas ao novo arquivo. Esse parâmetro pode ser definido como NULL.

packageThumbnail

[in] A interface IXpsOMImageResource que contém a imagem em miniatura a ser atribuída ao novo arquivo. Esse parâmetro pode ser definido como NULL.

documentSequencePrintTicket

[in] A interface IXpsOMPrintTicketResource que contém o tíquete de impressão no nível do pacote a ser atribuído ao novo arquivo. Esse parâmetro pode ser definido como NULL.

discardControlPartName

[in] A interface IOpcPartUri que contém o nome da parte de controle de descarte. Esse parâmetro pode ser definido como NULL.

documentType

[in] Especifica o tipo de documento do gravador de pacotes. O valor desse parâmetro não pode ser XPS_DOCUMENT_TYPE_UNSPECIFIED.

packageWriter

[out, retval] Um ponteiro para a nova interface IXpsOMPackageWriter criada por esse método.

Valor de retorno

Os valores possíveis incluem, mas não se limitam a, o seguinte. Para obter informações sobre os valores retornados da API de documento XPS que não estão listados aqui, consulte Erros de documento XPS.

S_OK: o método foi bem-sucedido e packageWriter foi definido corretamente.

E_INVALIDARG: o tipo de documento não era um formato de documento XPS válido.

Observações

Use esse método para produzir um gravador de pacotes para um documento MSXPS ou um documento OpenXPS. CreatePackageWriterOnFile, lançado no Windows 7, só cria arquivos de documento XPS no formato MSXPS.

referências adicionais

Referências adicionais: descrição do método herdado

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows 8 [aplicativos da área de trabalho \| Aplicativos UWP]
servidor com suporte mínimo	Windows Server 2012 [aplicativos da área de trabalho \| Aplicativos UWP]
da Plataforma de Destino	Windows
cabeçalho	xpsobjectmodel_1.h
biblioteca	Nenhum

Consulte também

IXpsOMObjectFactory1

Compartilhar via