Compartilhar via


Método IXpsOMPage::SetName (xpsobjectmodel.h)

Define a propriedade Name desta página.

Sintaxe

HRESULT SetName(
  [in] LPCWSTR name
);

Parâmetros

[in] name

Um ponteiro para a cadeia de caracteres de nome a ser definida como a propriedade Name da página. Um ponteiro NULL limpa qualquer nome atribuído anteriormente.

Retornar valor

O método retorna um HRESULT. Os valores possíveis incluem, mas não se limitam, 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.
XPS_E_INVALID_NAME
A cadeia de caracteres de nome contém um caractere que não é válido.

Comentários

A propriedade Name identifica a página atual como um ponto endereçável nomeado em um documento, permitindo que a página seja referenciada por um hiperlink.

Requisitos

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

Confira também

IXpsOMPage

Especificação de Papel XML

Erros de documento XPS