Compartilhar via


Função WsGetPrefixFromNamespace (webservices.h)

Essa função retorna o prefixo ao qual um namespace está associado. Pode haver mais de um prefixo no escopo e essa função é livre para retornar qualquer um deles.

Nota Em nenhuma condição, um chamador deve depender ou esperar que um prefixo específico seja retornado quando houver mais de um prefixo que possa ser retornado.
 

Se o valor do parâmetro necessário for definido como TRUE e o Namespace não estiver associado a nenhum Prefixo, uma exceção WS_E_INVALID_FORMAT será retornada. (Consulte Valores retornados dos Serviços Web do Windows.) Se o parâmetro necessário for FALSE e o Namespace não estiver associado a nenhum Prefixo, o parâmetro de prefixo será NULL e a função retornará S_FALSE.

Se WsWriteStartElement for chamado, mas o elemento não for confirmado, os Namespaces e Prefixos referenciados pelo elemento e quaisquer atributos no elemento não estarão disponíveis para essa função.

Sintaxe

HRESULT WsGetPrefixFromNamespace(
  [in]           WS_XML_WRITER       *writer,
  [in]           const WS_XML_STRING *ns,
  [in]           BOOL                required,
                 const WS_XML_STRING **prefix,
  [in, optional] WS_ERROR            *error
);

Parâmetros

[in] writer

Um ponteiro para um Gravador com o namespace a ser pesquisado. Este deve ser um objeto de WS_XML_WRITER válido retornado por WsCreateWriter e pode não ser NULL.

[in] ns

O namespace a ser pesquisado.

[in] required

Indica se um erro deve ou não ser retornado se um prefixo correspondente não for encontrado.

prefix

Uma referência a um prefixo associado ao namespace ou NULL se o valor do parâmetro necessário for FALSE e um namespace correspondente não for encontrado.

Nota O valor retornado é válido somente até que o gravador avance.

 

[in, optional] error

Um ponteiro para um objeto WS_ERROR em que informações adicionais sobre o erro devem ser armazenadas se a função falhar.

Retornar valor

Essa função pode retornar um desses valores.

Código de retorno Descrição
WS_E_INVALID_FORMAT
Os dados de entrada não estavam no formato esperado ou não tinham o valor esperado.

Comentários

Para o namespace "http://www.w3.org/XML/1998/namespace" ele retornará o prefixo "xml".

Para o namespace "http://www.w3.org/2000/xmlns/" ele retornará o prefixo "xmlns".

O prefixo retornado não deve ser modificado e só é válido até que o gravador avance.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows 7 [aplicativos da área de trabalho | Aplicativos UWP]
Servidor mínimo com suporte Windows Server 2008 R2 [aplicativos da área de trabalho | Aplicativos UWP]
Plataforma de Destino Windows
Cabeçalho webservices.h
Biblioteca WebServices.lib
DLL WebServices.dll