WsSetMessageProperty function (webservices.h)

  • Article

This operation sets a Messageproperty.

Syntax

HRESULT WsSetMessageProperty(
  [in]           WS_MESSAGE             *message,
  [in]           WS_MESSAGE_PROPERTY_ID id,
                 const void             *value,
  [in]           ULONG                  valueSize,
  [in, optional] WS_ERROR               *error
);

Parameters

[in] message

A pointer to the Message object with the property to set. The pointer must reference a valid WS_MESSAGE object and the referenced value may not be NULL.

[in] id

The identifier of the property to set.

value

A pointer to the property value to set. The pointer must have an alignment compatible with the type of the property.

[in] valueSize

The size in bytes of the property value.

[in, optional] error

A pointer to a WS_ERROR object where additional information about the error should be stored if the function fails.

Return value

This function can return one of these values.

Return code Description
E_INVALIDARG
 The property id was not supported for this object.

The specified size was not appropriate for the property.
E_OUTOFMEMORY
 There was not enough space to set the property value.
Other Errors
This function may return other errors not listed above.

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps | UWP apps]
Minimum supported server Windows Server 2008 R2 [desktop apps | UWP apps]
Target Platform Windows
Header webservices.h
Library WebServices.lib
DLL WebServices.dll