Função WsCreateWriter (webservices.h)

cria um Gravador XML com as propriedades especificadas.

Sintaxe

HRESULT WsCreateWriter(
                 const WS_XML_WRITER_PROPERTY *properties,
  [in]           ULONG                        propertyCount,
                 WS_XML_WRITER                **writer,
  [in, optional] WS_ERROR                     *error
);

Parâmetros

properties

Uma matriz de estruturas de WS_XML_WRITER_PROPERTY que contém propriedades opcionais para o gravador XML.

O valor desse parâmetro pode ser NULL; nesse caso, o parâmetro propertyCount deve ser 0 (zero).

[in] propertyCount

O número de propriedades na matriz de propriedades .

writer

Em caso de êxito, um ponteiro que recebe o endereço da estrutura WS_XML_WRITER que representa o gravador XML criado.

Quando não precisar mais dessa estrutura, você deverá liberá-la chamando WsFreeWriter.

[in, optional] error

Ponteiro para uma estrutura WS_ERROR que recebe informações de erro adicionais se a função falhar.

Retornar valor

Se a função for bem-sucedida, ela retornará NO_ERROR; caso contrário, ele retornará um código de erro HRESULT.

Código de retorno	Descrição
E_INVALIDARG	Um ou mais argumentos são inválidos.

Comentários

Use as funções WsSetOutput ou WsSetOutputToBuffer para escolher a codificação do gravador XML e indicar para onde direcionar a saída.

Um WS_XML_WRITER pode ser reutilizado chamando WsSetOutput ou WsSetOutputToBuffer novamente.

Consulte WS_XML_WRITER_PROPERTY_ID para obter as propriedades que podem ser usadas para configurar o gravador.

O gravador XML armazena todos os dados em buffer até que WsFlushWriter seja chamado. Isso permite que o chamador determine em qual granularidade gravar dados e se deve gravar esses dados de forma assíncrona. Os dados não são gravados até que WsFlushWriter seja chamado.

Se uma operação em um WS_XML_WRITER falhar, o gravador será deixado em um estado com falha e outras chamadas para o Gravador retornarão WS_E_OBJECT_FAULTED. (Consulte Valores retornados dos Serviços Web do Windows.) A única função possível chamará o gravador XML se isso ocorrer são WsSetOutput e WsSetOutputToBuffer para retornar o gravador XML a um estado utilizável ou WsFreeWriter para liberar o gravador XML.

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