WsAddMappedHeader-Funktion (webservices.h)

Fügt der Nachricht einen angegebenen zugeordneten Header hinzu.

Syntax

HRESULT WsAddMappedHeader(
  [in]           WS_MESSAGE          *message,
  [in]           const WS_XML_STRING *headerName,
  [in]           WS_TYPE             valueType,
  [in]           WS_WRITE_OPTION     writeOption,
  [in]           const void          *value,
  [in]           ULONG               valueSize,
  [in, optional] WS_ERROR            *error
);

Parameter

[in] message

Zeiger auf eine WS_MESSAGE-Struktur , die die Nachricht darstellt, der der zugeordnete Header hinzugefügt werden soll.

Die Nachricht kann sich in einem beliebigen Zustand mit Ausnahme WS_MESSAGE_STATE_EMPTY befinden (siehe WS_MESSAGE_STATE-Enumeration .

[in] headerName

Zeiger auf eine WS_XML_STRING , die den Namen des Headers enthält.

[in] valueType

Der Typ des zu deserialisierenden Headerwerts. Mögliche Typen und die entsprechenden Header finden Sie im WS_HEADER_TYPE

[in] writeOption

Gibt an, ob der Header erforderlich ist und wie der Wert zugeordnet wird. Weitere Informationen finden Sie in der WS_WRITE_OPTION-Enumeration .

[in] value

Der zu serialisierende Headerwert. Weitere Informationen finden Sie in der WS_WRITE_OPTION-Enumeration .

[in] valueSize

Die Größe des zu serialisierenden Werts in Bytes.

[in, optional] error

Zeiger auf eine WS_ERROR-Struktur , die zusätzliche Fehlerinformationen empfängt, wenn die Funktion fehlschlägt.

Rückgabewert

Wenn die Funktion erfolgreich ist, wird NO_ERROR zurückgegeben. Andernfalls wird ein HRESULT-Fehlercode zurückgegeben.

Hinweise

Eine Nachricht kann zusätzliche transportspezifische Informationen enthalten, die nicht Teil des Nachrichtenumschlags sind. Diese transportspezifischen Informationen können programmgesteuert als Header der Nachricht verfügbar gemacht werden. Die WsAddMappedHeader-Funktion wird verwendet, um einen solchen Header hinzuzufügen, der einem transportspezifischen Speicherort zugeordnet wird.

Wenn Sie den HTTP-Kanal verwenden, müssen Sie die erforderlichen Zuordnungen vor dem Aufrufen dieser Funktion angeben, um die Header hinzuzufügen. Weitere Informationen finden Sie unter WS_HTTP_MESSAGE_MAPPING.

Wenn Sie einen Header ersetzen, rufen Sie die WsRemoveMappedHeader-Funktion auf, um die vorhandenen Instanzen des Headers zu entfernen, bevor Sie WsAddMappedHeader aufrufen.

Anforderungen