Función WsReadMetadata (webservices.h)

  • Artículo

Lee un elemento Metadata y lo agrega a los documentos de metadatos del objeto Metadata.

El estado del objeto Metadata debe establecerse en WS_METADATA_STATE_CREATED.

Si se produce un error, el estado del objeto Metadata se restablece a WS_METADATA_STATE_FAULTED.

Nota La función consumirá un elemento si el elemento contiene metadatos. Si el elemento no se reconoce como que contiene metadatos o no se necesita el tipo determinado de metadatos, el elemento que no se lee.
 

Sintaxis

HRESULT WsReadMetadata(
  [in]           WS_METADATA     *metadata,
  [in]           WS_XML_READER   *reader,
  [in]           const WS_STRING *url,
  [in, optional] WS_ERROR        *error
);

Parámetros

[in] metadata

Puntero al objeto Metadata para almacenar los metadatos leídos. El puntero debe hacer referencia a un objeto WS_METADATA válido.

[in] reader

Puntero al objeto Lector XML usado para leer los metadatos. El puntero debe hacer referencia a un objeto WS_XML_READER válido y el lector debe colocarse en el elemento que contiene los metadatos deseados.

[in] url

Puntero a un objeto WS_STRING que hace referencia a la dirección URL de metadatos recuperada. La dirección URL se usa para realizar un seguimiento de los documentos de metadatos para resolver vínculos basados en direcciones URL entre documentos.

Nota La dirección URL DEBE estar completa. La dirección URL puede tener un identificador de fragmento.
 

Se admiten los siguientes esquemas de dirección URL:

  • WS_URL_HTTP_SCHEME_TYPE
  • WS_URL_HTTPS_SCHEME_TYPE
  • WS_URL_NETTCP_SCHEME_TYPE
Cada dirección URL especificada con esta función debe tener una dirección URL base única. La dirección URL base se calcula quitando cualquier identificador de fragmento de la dirección URL especificada.

Por ejemplo, si se especificaron las siguientes direcciones URL:


http://example.com/document1#fragment
http://example.com/document2

Las dos direcciones URL base serían:


http://example.com/document1
http://example.com/document2

[in, optional] error

Puntero a un objeto WS_ERROR donde se debe almacenar información adicional sobre el error 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.
WS_E_INVALID_OPERATION
 No se permite la operación debido al estado actual del objeto .
WS_E_QUOTA_EXCEEDED
 Se superó una cuota.
E_OUTOFMEMORY
 Se quedó sin memoria.
E_INVALIDARG
 Uno o más argumentos no son válidos.
S_FALSE
 El elemento no se consumió.
Otros errores
Esta función puede devolver otros errores no enumerados anteriormente.

Comentarios

Esta función reconoce los siguientes tipos de metadatos:

  • Documentos WSDL 1.1
  • documentos de WS-Policy 1.2

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