Funzione WsCreateMessageForChannel (webservices.h)

  • Articolo

Crea un messaggio da usare con un canale specificato.

Sintassi

HRESULT WsCreateMessageForChannel(
  [in]           WS_CHANNEL                *channel,
                 const WS_MESSAGE_PROPERTY *properties,
  [in]           ULONG                     propertyCount,
                 WS_MESSAGE                **message,
  [in, optional] WS_ERROR                  *error
);

Parametri

[in] channel

Puntatore a una struttura WS_CHANNEL che rappresenta il canale per il messaggio.

properties

Matrice di proprietà facoltative per il messaggio. Vedere WS_MESSAGE_PROPERTY.

Il valore di questo parametro può essere NULL, nel qual caso il parametro propertyCount deve essere 0 (zero).

[in] propertyCount

Numero di proprietà nella matrice delle proprietà .

message

In caso di esito positivo, un puntatore che riceve l'indirizzo della struttura WS_MESSAGE che rappresenta il nuovo messaggio.

Quando questa struttura non è più necessaria, è necessario liberarla chiamando WsFreeMessage.

[in, optional] error

Puntatore a una struttura WS_ERROR che riceve informazioni aggiuntive sull'errore 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ù argomenti non sono validi.
Altri errori
Questa funzione può restituire altri errori non elencati in precedenza.

Commenti

A differenza della funzione WsCreateMessage più generale, WsCreateMessageForChannel garantisce che la versione del messaggio usata sia appropriata per il canale.

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