WsRemoveHeader-Funktion (webservices.h)

  • Artikel

Entfernt das Standardobjekt WS_HEADER_TYPE aus einer Nachricht.

Die Funktion ist für die Verarbeitung von Headertypen konzipiert, die einmal in der Nachricht angezeigt werden und für den ultimativen Empfänger bestimmt sind. Header, die auf eine andere Rolle als den ultimativen Empfänger abzielen, werden ignoriert.

Verwenden Sie für anwendungsdefinierte Headertypen die WsRemoveCustomHeader-Funktion .

Syntax

HRESULT WsRemoveHeader(
  [in]           WS_MESSAGE     *message,
  [in]           WS_HEADER_TYPE headerType,
  [in, optional] WS_ERROR       *error
);

Parameter

[in] message

Ein Zeiger auf das Message-Objekt mit dem zu entfernenden Header. Die Nachricht kann sich in einem beliebigen Zustand mit Ausnahme WS_MESSAGE_STATE_EMPTY befinden.

[in] headerType

Gibt den Typ des zu entfernenden Headers an.

[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
 Es sind mehrere Instanzen des Headertyps in der Nachricht vorhanden.
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

Wenn in der Nachricht ein Header des angegebenen Typs vorhanden ist, wird er entfernt. Wenn der Header nicht vorhanden ist, wird keine Aktion ausgeführt, und die Funktion wird erfolgreich abgeschlossen.

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