WsGetMessageProperty function

Retrieves a specified Message object property. The property to retrieve is identified by a WS_MESSAGE_PROPERTY_ID input parameter.

Syntax

HRESULT WINAPI  WsGetMessageProperty(
  _In_     WS_MESSAGE*            message,
  _In_     WS_MESSAGE_PROPERTY_ID id,
           void*                  value,
  _In_     ULONG                  valueSize,
  _In_opt_ WS_ERROR*              error
);

Parameters

message [in]

A pointer to a Message object containing the desired property. This parameter must be a valid WS_LISTENER object.

id [in]

This is a WS_MESSAGE_PROPERTY_ID enumerator value that identifies the desired property.

value

A reference to a location for storing the retrieved property value. The pointer must have an alignment compatible with the type of the property.

valueSize [in]

The byte-length buffer size allocated by the caller to store the retrieved property value.

error [in, optional]

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.

Requirements