Funzione WsRemoveCustomHeader (webservices.h)

  • Articolo

Rimuove un'intestazione personalizzata dal messaggio.

Questa funzione è progettata per gestire i tipi di intestazioni che vengono visualizzati una volta nel messaggio e sono destinati al ricevitore finale. Le intestazioni destinate a un ruolo diverso dal ricevitore finale vengono ignorate.

Sintassi

HRESULT WsRemoveCustomHeader(
  [in]           WS_MESSAGE          *message,
  [in]           const WS_XML_STRING *headerName,
  [in]           const WS_XML_STRING *headerNs,
  [in, optional] WS_ERROR            *error
);

Parametri

[in] message

Puntatore all'oggetto Message con l'intestazione da rimuovere.

Il messaggio può trovarsi in qualsiasi stato ad eccezione di WS_MESSAGE_STATE_EMPTY.

[in] headerName

Puntatore all'oggetto WS_XML_STRING che fa riferimento al "nome locale" dell'elemento di intestazione da rimuovere.

[in] headerNs

Puntatore all'oggetto WS_XML_STRING che fa riferimento allo spazio dei nomi dell'elemento di intestazione da rimuovere.

[in, optional] error

Puntatore a un oggetto WS_ERROR in cui devono essere archiviate informazioni aggiuntive sull'errore se la funzione ha esito negativo.

Valore restituito

Questa funzione può restituire uno di questi valori.

Codice restituito Descrizione
WS_E_INVALID_FORMAT
 Nel messaggio sono presenti più istanze del tipo di intestazione.
E_OUTOFMEMORY
 Memoria insufficiente per serializzare l'intestazione.
E_INVALIDARG
 Uno o più parametri non sono corretti.
Altri errori
Questa funzione può restituire altri errori non elencati in precedenza.

Commenti

Se nel messaggio è presente un'intestazione del tipo specificato, viene rimossa. Se l'intestazione non esiste, la funzione non esegue alcuna azione e viene completata correttamente.

Requisiti

   
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