WsReadMetadata-Funktion (webservices.h)

  • Artikel

Liest ein Metadata-Element und fügt es den Metadatendokumenten des Metadata-Objekts hinzu.

Der Metadatenobjektstatus muss auf WS_METADATA_STATE_CREATED festgelegt werden.

Bei Einem Fehler wird der Metadatenobjektstatus auf WS_METADATA_STATE_FAULTED zurückgesetzt.

Hinweis Die Funktion nutzt ein -Element, wenn das Element Metadaten enthält. Wenn das Element nicht als enthaltende Metadaten erkannt wird oder der bestimmte Typ von Metadaten nicht benötigt wird, wird das Element nicht gelesen.
 

Syntax

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

Parameter

[in] metadata

Ein Zeiger auf das Metadata-Objekt zum Speichern der gelesenen Metadaten. Der Zeiger muss auf ein gültiges WS_METADATA-Objekt verweisen.

[in] reader

Ein Zeiger auf das XML Reader-Objekt , das zum Lesen der Metadaten verwendet wird. Der Zeiger muss auf ein gültiges WS_XML_READER-Objekt verweisen, und der Reader muss auf dem Element positioniert werden, das die gewünschten Metadaten enthält.

[in] url

Ein Zeiger auf ein WS_STRING-Objekt , das auf die abgerufene Metadaten-URL verweist. Die URL wird verwendet, um die Metadatendokumente zum Auflösen von URL-basierten Links zwischen Dokumenten nachzuverfolgen.

Hinweis Die URL MUSS voll qualifiziert sein. Die URL kann einen Fragmentbezeichner aufweisen.
 

Die folgenden URL-Schemas werden unterstützt:

  • WS_URL_HTTP_SCHEME_TYPE
  • WS_URL_HTTPS_SCHEME_TYPE
  • WS_URL_NETTCP_SCHEME_TYPE
Jede URL, die mithilfe dieser Funktion angegeben wird, muss über eine eindeutige Basis-URL verfügen. Die Basis-URL wird berechnet, indem ein beliebiger Fragmentbezeichner aus der angegebenen URL entfernt wird.

Wenn beispielsweise die folgenden URLs angegeben wurden:


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

Die beiden Basis-URLs wären:


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

[in, optional] error

Ein Zeiger auf ein WS_ERROR-Objekt , in dem zusätzliche Informationen zum Fehler gespeichert werden sollen, wenn die Funktion fehlschlägt.

Rückgabewert

Diese Funktion kann einen dieser Werte zurückgeben.

Rückgabecode Beschreibung
WS_E_INVALID_FORMAT
 Die Eingabedaten hatten nicht das erwartete Format oder hatten nicht den erwarteten Wert.
WS_E_INVALID_OPERATION
 Der Vorgang ist aufgrund des aktuellen Zustands des Objekts nicht zulässig.
WS_E_QUOTA_EXCEEDED
 Ein Kontingent wurde überschritten.
E_OUTOFMEMORY
 Der Arbeitsspeicher ist nicht mehr vorhanden.
E_INVALIDARG
 Mindestens ein Argument ist ungültig.
S_FALSE
 Das Element wurde nicht verwendet.
Andere Fehler
Diese Funktion gibt möglicherweise andere Fehler zurück, die oben nicht aufgeführt sind.

Hinweise

Diese Funktion erkennt die folgenden Metadatentypen:

  • WSDL 1.1-Dokumente
  • Dokumente WS-Policy 1.2

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows 7 [Desktop-Apps | UWP-Apps]
Unterstützte Mindestversion (Server) Windows Server 2008 R2 [Desktop-Apps | UWP-Apps]
Zielplattform Windows
Kopfzeile webservices.h
Bibliothek WebServices.lib
DLL WebServices.dll