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

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

  • Статья

Отправляет сообщение, которое является ответом на полученное сообщение.

Синтаксис

HRESULT WsSendReplyMessage(
  [in]           WS_CHANNEL                   *channel,
  [in]           WS_MESSAGE                   *replyMessage,
  [in]           const WS_MESSAGE_DESCRIPTION *replyMessageDescription,
  [in]           WS_WRITE_OPTION              writeOption,
                 const void                   *replyBodyValue,
  [in]           ULONG                        replyBodyValueSize,
  [in]           WS_MESSAGE                   *requestMessage,
  [in, optional] const WS_ASYNC_CONTEXT       *asyncContext,
  [in, optional] WS_ERROR                     *error
);

Параметры

[in] channel

Указатель на объект Channel , на который отправляется ответное сообщение. Указатель должен ссылаться на допустимый объект WS_CHANNEL .

[in] replyMessage

Указатель на объект Message для отправки ответа. Указатель должен ссылаться на допустимый объект WS_MESSAGE .

Состояние объекта сообщения должно быть установлено в WS_MESSAGE_STATE_EMPTY или WS_MESSAGE_STATE_INITIALIZED.

Примечание Если предоставляется инициализированное сообщение, оно должно быть инициализировано с помощью WS_REPLY_MESSAGE или WS_FAULT_MESSAGE.
 

[in] replyMessageDescription

Указатель на объект WS_MESSAGE_DESCRIPTION . Поле действияWS_MESSAGE_DESCRIPTION используется в качестве заголовка действия для ответного сообщения. Если никаких действий не требуется, это поле может иметь значение NULL .

Поле bodyElementDescriptionWS_MESSAGE_DESCRIPTION используется для сериализации текста ответного сообщения. Это поле может иметь значение NULL , если не нужно использовать элемент body. Сведения о том, как bodyElementDescription используется для сериализации значения, см. в разделе WsWriteBody.

[in] writeOption

Определяет, требуется ли элемент body и как выделяется значение.

Дополнительные сведения см. в разделе WS_WRITE_OPTION .

replyBodyValue

Пустой указатель на значение для сериализации в ответном сообщении.

[in] replyBodyValueSize

Размер сериализуемого значения ответа в байтах.

[in] requestMessage

Указатель на объект WS_MESSAGE, инкапсулирующий текст сообщения запроса. Используется для получения сведений о корреляции, используемых при формулировке ответного сообщения.

Примечание Сообщение может находиться в любом состоянии, кроме WS_MESSAGE_STATE_EMPTY.
 

[in, optional] asyncContext

Указатель на WS_ASYNC_CONTEXT структуру данных с информацией об асинхронном вызове функции. Значение NULL указывает на запрос для синхронной операции.

[in, optional] error

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

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

Эта функция может возвращать одно из этих значений.

Код возврата Описание
WS_S_ASYNC
 Асинхронная операция по-прежнему находится в состоянии ожидания.
WS_E_OPERATION_ABORTED
 Операция была прервана.
WS_E_INVALID_OPERATION
 Операция не разрешена из-за текущего состояния объекта .
WS_E_ENDPOINT_DISCONNECTED
 Подключение к удаленной конечной точке было прервано.
WS_E_INVALID_FORMAT
 Входные данные не были в ожидаемом формате или не имели ожидаемого значения.
WS_E_OPERATION_TIMED_OUT
 Операция не была завершена в отведенное время.
WS_E_QUOTA_EXCEEDED
 Превышена квота.
WS_E_SECURITY_VERIFICATION_FAILURE
 Проверка безопасности не прошла успешно для полученных данных.
WS_E_SECURITY_SYSTEM_FAILURE
 Сбой операции безопасности на платформе веб-служб Windows.
WS_E_SECURITY_TOKEN_EXPIRED
 Маркер безопасности был отклонен сервером, так как срок его действия истек.
E_OUTOFMEMORY
 Не хватает памяти.
E_INVALIDARG
 Один или несколько аргументов недопустимы.
Другие ошибки
Эта функция может возвращать другие ошибки, не перечисленные выше.

Комментарии

Ответные сообщения будут включать сведения о корреляции в соответствии с WS_ADDRESSING_VERSION. Дополнительные сведения о корреляции ответных сообщений см. в статье Общие сведения об уровне канала.

Требования

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