Поделиться через


Функция WsCreateMessage (webservices.h)

Создает объект сообщения с указанными свойствами.

Синтаксис

HRESULT WsCreateMessage(
  [in]           WS_ENVELOPE_VERSION       envelopeVersion,
  [in]           WS_ADDRESSING_VERSION     addressingVersion,
                 const WS_MESSAGE_PROPERTY *properties,
  [in]           ULONG                     propertyCount,
                 WS_MESSAGE                **message,
  [in, optional] WS_ERROR                  *error
);

Параметры

[in] envelopeVersion

Значение перечисления WS_ENVELOPE_VERSION , указывающее версию конверта для сообщения.

[in] addressingVersion

WS_ADDRESSING_VERSION, указывающий версию адресации для сообщения.

properties

Массив необязательных свойств сообщения. См . WS_MESSAGE_PROPERTY.

Значение этого параметра может иметь значение NULL. В этом случае параметр propertyCount должен иметь значение 0 (ноль).

[in] propertyCount

Количество свойств в массиве свойств .

message

При успешном выполнении — указатель, который получает адрес WS_MESSAGE структуры, представляющей новое сообщение.

Если эта структура больше не нужна, ее необходимо освободить, вызвав WsFreeMessage.

[in, optional] error

Указатель на структуру WS_ERROR , которая получает дополнительные сведения об ошибке в случае сбоя функции.

Возвращаемое значение

Если функция завершается успешно, она возвращает NO_ERROR; в противном случае возвращается код ошибки HRESULT.

Код возврата Описание
E_OUTOFMEMORY
Недостаточно памяти для завершения операции.
E_INVALIDARG
Один или несколько аргументов являются недопустимыми.
Другие ошибки
Эта функция может возвращать другие ошибки, не перечисленные выше.

Комментарии

Объект сообщения — это средство доставки для веб-служб Windows. Для отправки или получения последовательных сообщений можно использовать один объект сообщения. Повторное использование объекта сообщения таким образом может сократить выделение памяти. Если сообщение больше не требуется, необходимо освободить память, вызвав WsFreeMessage. (Дополнительные сведения о повторном использовании объектов сообщений см. в разделе WsResetMessage .)

Если вы создаете сообщение для использования с определенным каналом, используйте функцию WsCreateMessageForChannel , которая обеспечит правильную версию сообщения для канала.

Требования

Требование Значение
Минимальная версия клиента Windows 7 [классические приложения | Приложения UWP]
Минимальная версия сервера Windows Server 2008 R2 [классические приложения | Приложения UWP]
Целевая платформа Windows
Header webservices.h
Библиотека WebServices.lib
DLL WebServices.dll