WsReadEndpointAddressExtension-Funktion (webservices.h)

  • Artikel

Liest eine Erweiterung des WS_ENDPOINT_ADDRESS.

Syntax

HRESULT WsReadEndpointAddressExtension(
  [in]           WS_XML_READER                      *reader,
  [in]           WS_ENDPOINT_ADDRESS                *endpointAddress,
  [in]           WS_ENDPOINT_ADDRESS_EXTENSION_TYPE extensionType,
  [in]           WS_READ_OPTION                     readOption,
  [in]           WS_HEAP                            *heap,
                 void                               *value,
  [in]           ULONG                              valueSize,
  [in, optional] WS_ERROR                           *error
);

Parameter

[in] reader

Der XML-Reader, der zum Lesen der Erweiterung verwendet werden soll.

Die Funktion legt die Eingabe des Readers automatisch fest, wenn dies zum Lesen der Erweiterungen erforderlich ist.

[in] endpointAddress

Die Endpunktadresse, die die Erweiterungen enthält.

[in] extensionType

Der Typ der zu lesenden Erweiterung.

[in] readOption

Gibt an, ob der Wert erforderlich ist und wie der Wert zugeordnet wird. Weitere Informationen finden Sie unter WS_READ_OPTION .

Dieser Parameter muss über einen der folgenden Werte verfügen:

[in] heap

Der Heap, der zum Speichern des gelesenen Werts verwendet werden soll.

value

Die Adresse eines Puffers, an dem der Wert gelesen werden soll.

Wenn Sie WS_READ_REQUIRED_VALUE für den readOption-Parameter verwenden, muss der Puffer die Größe des Typs der zu lesenden Erweiterung aufweisen (die je nach WS_ENDPOINT_ADDRESS_EXTENSION_TYPE variiert).

Wenn Sie WS_READ_REQUIRED_POINTER oder WS_READ_OPTIONAL_POINTER verwenden, sollte der Puffer die Größe eines Zeigers aufweisen.

[in] valueSize

Die Größe des Puffers, den der Aufrufer für den gelesenen Wert zugewiesen hat.

Diese Größe sollte der Größe des Puffers entsprechen, der mithilfe des value-Parameters übergeben wird.

[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
E_INVALIDARG
 Der Erweiterungstyp war ungültig.

Die Größe des angegebenen Puffers war nicht korrekt.

Ein erforderlicher Parameter war NULL.
WS_E_INVALID_FORMAT
 Die Eingabedaten hatten nicht das erwartete Format oder hatten nicht den erwarteten Wert.
E_OUTOFMEMORY
 Der Arbeitsspeicher ist nicht mehr vorhanden.
Andere Fehler
Diese Funktion gibt möglicherweise andere Fehler zurück, die oben nicht aufgeführt sind.

Hinweise

Der zurückgegebene Wert ist gültig, bis der Heap freigegeben oder zurückgesetzt wird.

Wenn der angeforderte Erweiterungstyp mehrmals im Erweiterungspuffer angezeigt wird, wird die erste instance zurückgegeben.

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