WsReadMetadata function

Reads a Metadata element and adds it to the Metadata documents of the Metadata object. The Metadata object state must be set to WS_METADATA_STATE_CREATED. On error the Metadata object state is reset to WS_METADATA_STATE_FAULTED.

Syntax

HRESULT WINAPI  WsReadMetadata(
  _In_     WS_METADATA*     metadata,
  _In_     WS_XML_READER*   reader,
  _In_     const WS_STRING* url,
  _In_opt_ WS_ERROR*        error
);

Parameters

metadata [in]

A pointer to the Metadata object for storing the metadata read. The pointer must reference a valid WS_METADATA object.

reader [in]

A pointer to the XML Reader object used to read the metadata. The pointer must reference a valid WS_XML_READER object and the reader must be positioned on the element containing the desired metadata.

url [in]

A pointer to a WS_STRING object referencing the retrieved metadata URL. The URL is used to track the metadata documents for resolving URL-based links between documents.

Note   The URL MUST be fully qualified. The URL can have a fragment identifier.

 

The following URL schemes are supported:

• WS_URL_HTTP_SCHEME_TYPE
• WS_URL_HTTPS_SCHEME_TYPE
• WS_URL_NETTCP_SCHEME_TYPE

Each URL specified using this function must have a unique base URL. The base URL is computed by removing any fragment identifier from the URL specified. For example if the following URLs were specified:

Copy

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

The two base URLs would be:

Copy

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

error [in, optional]

A pointer to a WS_ERROR object where additional information about the error should be stored if the function fails.

Return value

This function can return one of these values.

Remarks

This function recognizes the following types of metadata:

• WSDL 1.1 documents
• WS-Policy 1.2 documents

Requirements