WsReadMetadata 函数 (webservices.h)

读取 Metadata 元素并将其添加到 Metadata 对象的元数据文档。

元数据对象状态必须设置为 WS_METADATA_STATE_CREATED

出现错误时,元数据对象状态重置为 WS_METADATA_STATE_FAULTED

注意 如果该元素包含元数据,函数将使用 元素。 如果元素未被识别为包含元数据,或者不需要特定类型的元数据,则不会读取该元素。
 

语法

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

参数

[in] metadata

指向 元数据 对象的指针,用于存储读取的元数据。 指针必须引用有效的 WS_METADATA 对象。

[in] reader

指向用于读取元数据的 XML Reader 对象的指针。 指针必须引用有效的 WS_XML_READER 对象,并且读取器必须位于包含所需元数据的元素上。

[in] url

指向引用检索的元数据 URL 的WS_STRING 对象的指针。 URL 用于跟踪元数据文档,以解析文档之间的基于 URL 的链接。

注意 URL 必须完全限定。 URL 可以具有片段标识符。
 

支持以下 URL 方案:

  • WS_URL_HTTP_SCHEME_TYPE
  • WS_URL_HTTPS_SCHEME_TYPE
  • WS_URL_NETTCP_SCHEME_TYPE
使用此函数指定的每个 URL 必须具有唯一的基 URL。 基 URL 是通过从指定的 URL 中删除任何片段标识符来计算的。

例如,如果指定了以下 URL:


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

两个基 URL 为:


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

[in, optional] error

指向 WS_ERROR 对象的指针,如果函数失败,应存储有关错误的其他信息。

返回值

此函数可以返回其中一个值。

返回代码 说明
WS_E_INVALID_FORMAT
输入数据的格式不是预期的,或者没有预期的值。
WS_E_INVALID_OPERATION
由于 对象的当前状态,不允许此操作。
WS_E_QUOTA_EXCEEDED
超出配额。
E_OUTOFMEMORY
内存不足。
E_INVALIDARG
一个或多个参数无效。
S_FALSE
未使用 元素。
其他错误
此函数可能会返回上面未列出的其他错误。

注解

此函数可识别以下类型的元数据:

  • WSDL 1.1 文档
  • WS-Policy 1.2 文档

要求

要求
最低受支持的客户端 Windows 7 [桌面应用 |UWP 应用]
最低受支持的服务器 Windows Server 2008 R2 [桌面应用 |UWP 应用]
目标平台 Windows
标头 webservices.h
Library WebServices.lib
DLL WebServices.dll