Función WsReadElement (webservices.h)

  • Artículo

Lee un elemento que genera un valor del WS_TYPE especificado.

Sintaxis

HRESULT WsReadElement(
  [in]           WS_XML_READER                *reader,
  [in]           const WS_ELEMENT_DESCRIPTION *elementDescription,
  [in]           WS_READ_OPTION               readOption,
  [in, optional] WS_HEAP                      *heap,
                 void                         *value,
  [in]           ULONG                        valueSize,
  [in, optional] WS_ERROR                     *error
);

Parámetros

[in] reader

Lector situado en el XML que se va a deserializar.

[in] elementDescription

Puntero a una descripción de cómo deserializar el elemento.

[in] readOption

Si el elemento es necesario y cómo asignar el valor.
Consulte WS_READ_OPTION para obtener más información.

[in, optional] heap

Montón en el que se almacenarán los valores deserializados.

value

La interpretación de este parámetro depende del WS_READ_OPTION.

[in] valueSize

La interpretación de este parámetro depende del WS_READ_OPTION.

[in, optional] error

Especifica dónde se debe almacenar información de error adicional si se produce un error en la función.

Valor devuelto

Esta función puede devolver uno de estos valores.

Código devuelto Descripción
WS_E_INVALID_FORMAT
 Los datos de entrada no tenían el formato esperado o no tenían el valor esperado.
E_OUTOFMEMORY
 Se quedó sin memoria.
WS_E_QUOTA_EXCEEDED
 Se superó la cuota de tamaño del montón.
E_INVALIDARG
 Uno o más argumentos no son válidos.

Comentarios

Esta API se moverá al siguiente elemento, comprobará su nombre y espacio de nombres y, a continuación, deserializará el contenido como un valor con tipo.

Si se produce un error en la API, el estado del lector de entrada se vuelve indefinido. Las únicas API que se pueden usar en el lector si esto ocurre son WsSetInput y WsSetInputToBuffer para devolver el lector a un estado utilizable, o WsFreeReader para liberar el lector.

Requisitos

Requisito Value
Cliente mínimo compatible Windows 7 [aplicaciones de escritorio | Aplicaciones para UWP]
Servidor mínimo compatible Windows Server 2008 R2 [aplicaciones de escritorio | Aplicaciones para UWP]
Plataforma de destino Windows
Encabezado webservices.h
Library WebServices.lib
Archivo DLL WebServices.dll