Funzione WsAddMappedHeader (webservices.h)

Articolo
02/01/2024

Aggiunge un'intestazione mappata specificata al messaggio.

Sintassi

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
);

Parametri

[in] message

Puntatore a una struttura WS_MESSAGE che rappresenta il messaggio a cui aggiungere l'intestazione mappata.

Il messaggio può essere in qualsiasi stato tranne WS_MESSAGE_STATE_EMPTY (vedere l'enumerazione WS_MESSAGE_STATE .

[in] headerName

Puntatore a un WS_XML_STRING contenente il nome dell'intestazione.

[in] valueType

Tipo di valore dell'intestazione da deserializzare. Per i tipi possibili e le intestazioni corrispondenti, vedere la WS_HEADER_TYPE

[in] writeOption

Indica se l'intestazione è necessaria e la modalità di allocazione del valore. Per altre informazioni, vedere l'enumerazione WS_WRITE_OPTION .

[in] value

Valore dell'intestazione da serializzare. Per altre informazioni, vedere l'enumerazione WS_WRITE_OPTION .

[in] valueSize

Dimensioni del valore serializzato, in byte.

[in, optional] error

Puntatore a una struttura WS_ERROR che riceve informazioni di errore aggiuntive se la funzione ha esito negativo.

Valore restituito

Se la funzione ha esito positivo, restituisce NO_ERROR; in caso contrario, restituisce un codice di errore HRESULT.

Codice restituito	Descrizione
E_OUTOFMEMORY	Memoria insufficiente per completare l'operazione.
E_INVALIDARG	Uno o più parametri non sono corretti.
Altri errori	Questa funzione può restituire altri errori non elencati sopra.

Commenti

Un messaggio può contenere informazioni aggiuntive specifiche del trasporto che non fanno parte della busta del messaggio. Queste informazioni specifiche del trasporto possono essere esposte a livello di codice come intestazioni del messaggio. La funzione WsAddMappedHeader viene usata per aggiungere un'intestazione di questo tipo che verrà mappata in una posizione specifica del trasporto.

Quando si usa il canale HTTP, è necessario specificare i mapping necessari prima di chiamare questa funzione per aggiungere le intestazioni. Per altre informazioni, vedere WS_HTTP_MESSAGE_MAPPING.

Se si sostituisce un'intestazione, chiamare la funzione WsRemoveMappedHeader per rimuovere le istanze esistenti dell'intestazione prima di chiamare WsAddMappedHeader.

Requisiti

Requisito	Valore
Client minimo supportato	Windows 7 [app desktop \| App UWP]
Server minimo supportato	Windows Server 2008 R2 [app desktop \| App UWP]
Piattaforma di destinazione	Windows
Intestazione	webservices.h
Libreria	WebServices.lib
DLL	WebServices.dll

Condividi tramite