WsGetCustomHeader-Funktion (webservices.h)

Artikel
08/27/2023

Sucht einen anwendungsdefinierten Header der Nachricht und deserialisiert sie.

Syntax

HRESULT WsGetCustomHeader(
  [in]           WS_MESSAGE                   *message,
  [in]           const WS_ELEMENT_DESCRIPTION *customHeaderDescription,
  [in]           WS_REPEATING_HEADER_OPTION   repeatingOption,
  [in]           ULONG                        headerIndex,
  [in]           WS_READ_OPTION               readOption,
  [in, optional] WS_HEAP                      *heap,
                 void                         *value,
  [in]           ULONG                        valueSize,
                 ULONG                        *headerAttributes,
  [in, optional] WS_ERROR                     *error
);

Parameter

[in] message

Die Nachricht, die den Header enthält.

Die Nachricht kann sich in einem beliebigen Zustand befinden, aber WS_MESSAGE_STATE_EMPTY.

[in] customHeaderDescription

Eine WS_ELEMENT_DESCRIPTION , die das Headerelement beschreibt.

[in] repeatingOption

Gibt an, ob die Kopfzeile in der Nachricht möglicherweise mehrmals angezeigt wird.

Wenn WS_REPEATING_HEADER verwendet wird, gibt der Headerindex an, welcher der Header mit dem angegebenen headerName zurückgegeben werden soll.

Wenn WS_SINGLETON_HEADER verwendet wird, muss der headerIndex null sein.

[in] headerIndex

Der nullbasierte Index des Headers innerhalb der Gruppe von Headern mit dem angegebenen headerName.

[in] readOption

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

[in, optional] heap

Der Heap, in dem die deserialisierten Headerdaten gespeichert werden sollen. Wenn dies NULL ist, wird der Nachrichtenheap gemäß den Anforderungen des WS_READ_OPTION verwendet.

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.

headerAttributes

Gibt den WS_HEADER_ATTRIBUTES für diesen Header zurück. Der Zeiger kann NULL sein. In diesem Fall werden keine Attribute zurückgegeben.

[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	Der Header ist nicht vorhanden und erforderlich. WS_SINGLETON_HEADER angegeben wurde, und es sind mehrere Instanzen des Headertyps in der Nachricht vorhanden. Die Eingabedaten waren nicht im erwarteten Format.
WS_E_QUOTA_EXCEEDED	Das Größenkontingent des Heaps wurde überschritten.
E_OUTOFMEMORY	Es war nicht genügend Arbeitsspeicher verfügbar, um den Header zu deserialisieren.
E_INVALIDARG	Einer oder mehrere der Parameter sind falsch.
Andere Fehler	Diese Funktion gibt möglicherweise andere Fehler zurück, die oben nicht aufgeführt sind.

Hinweise

Diese API arbeitet mit Headern, die auf den ultimativen Empfänger ausgerichtet sind.
Header, für die eine andere Rolle bzw. ein anderer Akteur als der ultimative Empfänger bestimmt ist, werden von dieser API ignoriert.

Anforderungen


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