WsReadAttribute-Funktion (webservices.h)

  • Artikel

Lesen Sie ein Attribut, das einen Wert des angegebenen WS_TYPE erzeugt.

Syntax

HRESULT WsReadAttribute(
  [in]           WS_XML_READER                  *reader,
  [in]           const WS_ATTRIBUTE_DESCRIPTION *attributeDescription,
  [in]           WS_READ_OPTION                 readOption,
  [in, optional] WS_HEAP                        *heap,
                 void                           *value,
  [in]           ULONG                          valueSize,
  [in, optional] WS_ERROR                       *error
);

Parameter

[in] reader

Der Reader, der auf dem Element positioniert ist, das das Attribut enthält.

[in] attributeDescription

Ein Zeiger auf eine Beschreibung der Deserialisierung des Attributs.

[in] readOption

Gibt an, ob das Attribut erforderlich ist und wie der Wert zugeordnet werden soll. Weitere Informationen finden Sie unter WS_READ_OPTION .

[in, optional] heap

Der Heap, in dem die deserialisierten Werte gespeichert werden sollen.

value

Die Interpretation dieses Parameters hängt vom WS_READ_OPTION ab.

[in] valueSize

Die Interpretation dieses Parameters hängt vom WS_READ_OPTION ab.

[in, optional] error

Gibt an, wo zusätzliche Fehlerinformationen 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 waren nicht im erwarteten Format oder hatten nicht den erwarteten Wert.
E_OUTOFMEMORY
 Der Arbeitsspeicher ist nicht mehr vorhanden.
WS_E_QUOTA_EXCEEDED
 Das Größenkontingent des Heaps wurde überschritten.
E_INVALIDARG
 Mindestens ein Argument ist ungültig.

Hinweise

Diese API sucht nach dem Attribut, das den Namen und den Namespace angegeben hat, und deserialisiert dann den Inhalt als typisierten Wert.

Wenn die API fehlschlägt, wird der Status des Eingabelesers nicht definiert. Die einzigen APIs, die in diesem Fall für den Reader verwendet werden können, sind WsSetInputInput und WsSetInputToBuffer , um den Reader in einen verwendbaren Zustand zurückzugeben, oder WsFreeReader , um den Reader freizugeben.

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