Função WsCreateReader (webservices.h)

Cria um leitor XML com as propriedades especificadas.

Sintaxe

HRESULT WsCreateReader(
                 const WS_XML_READER_PROPERTY *properties,
  [in]           ULONG                        propertyCount,
                 WS_XML_READER                **reader,
  [in, optional] WS_ERROR                     *error
);

Parâmetros

properties

Uma matriz de estruturas WS_XML_READER_PROPERTY que contém propriedades opcionais para o leitor de XML.

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

Para obter as propriedades que tiy pode usar para configurar o leitor de XML, consulte a enumeração WS_XML_READER_PROPERTY_ID .

[in] propertyCount

O número de propriedades na matriz de propriedades .

reader

Em caso de êxito, um ponteiro que recebe o endereço da estrutura WS_XML_READER que representa o novo leitor de XML.

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

[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.

Comentários

Use as funções WsSetInput ou WsSetInputToBuffer para escolher a codificação do leitor XML e indicar a origem da entrada.

Se WS_READ_CALLBACK for especificado na estrutura WS_XML_READER_INPUT passada para a função WsSetInput , o leitor XML lerá dados adicionais somente quando WsFillReader for chamado. Isso permite que o chamador determine em qual granularidade ler dados e se deve ler esses dados de forma assíncrona.

Uma estrutura WS_XML_READER pode ser reutilizado chamando WsSetInput ou WsSetInputToBuffer novamente.

Se alguma operação de API que opera em um WS_XML_READER falhar, o leitor de XML será deixado em um estado com falha e outras chamadas de função retornarão WS_E_OBJECT_FAULTED. (Consulte Valores retornados dos Serviços Web do Windows.) A única função possível chamará o leitor XML se isso ocorrer são WsSetInput e WsSetInputToBuffer para retornar o leitor XML a um estado utilizável ou WsFreeReader para liberar o objeto de leitor 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