функция MI_Context_WriteMessage (mi.h)

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

Синтаксис

MI_INLINE MI_Result MI_INLINE_CALL MI_Context_WriteMessage(
  [in] MI_Context    *context,
       MI_Uint32     channel,
       const MI_Char *message
);

Параметры

[in] context

Контекст запроса.

channel

Канал, в который выполняется запись. Клиент может выбрать один из следующих каналов:

MI_WRITEMESSAGE_CHANNEL_WARNING (0)

Канал, используемый для трансляции предупреждающих сообщений.

MI_WRITEMESSAGE_CHANNEL_VERBOSE (1)

Канал, используемый для трансляции подробных информационных сообщений.

MI_WRITEMESSAGE_CHANNEL_DEBUG (2)

Канал, используемый для трансляции отладочную информацию.

message

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

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

Значение перечисления MI_Result , указывающее код возврата функции. Это может быть один из следующих кодов.

Комментарии

Поставщик вызывает эту функцию, когда клиенту необходимо отправить операционное сообщение о чем-то. Примером операционного сообщения может быть уведомление клиента о том, какие файлы были удалены в длительном процессе удаления, чтобы клиент смог обновить пользовательский интерфейс. Следует соблюдать осторожность, чтобы не использовать эту функцию чрезмерно, так как она может замедлить работу поставщика. Клиент может при необходимости зарегистрироваться для получения этих сообщений с помощью асинхронного обратного вызова. Если клиент не регистрирует эти сообщения, сервер проигнорирует сообщение.

Требования

См. также раздел

MI_Context