Expand Minimize

MI_Context_WriteMessage function

Sends an operational message to the client.

Syntax


 MI_INLINE MI_Result MI_Context_WriteMessage(
  _In_  MI_Context *context,
  MI_Uint32 channel,
  _In_z_ const MI_Char *message
);

Parameters

context [in]

Request context.

channel

The channel to which to write. The client can select from one these channels:

ValueMeaning
MI_WRITEMESSAGE_CHANNEL_WARNING
0

Channel used to broadcast warning messages.

MI_WRITEMESSAGE_CHANNEL_VERBOSE
1

Channel used to broadcast verbose informational messages.

MI_WRITEMESSAGE_CHANNEL_DEBUG
2

Channel used to broadcast debugging information.

 

message

A null-terminated string that represents the message to be sent to the client. The message should be localized if it is a warning or verbose.

Return value

A value of the MI_Result enumeration that specifies the function return code. This can be one of the following codes.

Return codeDescription
MI_RESULT_OK

The operation succeeded.

MI_RESULT_SERVER_LIMITS_EXCEEDED

There is not enough memory to complete the request.

MI_RESULT_INVALID_PARAMETER

One or more parameters passed to the function were not valid.

MI_RESULT_FAILED

A failure not covered by other MI_Result error codes.

 

Remarks

A provider calls this function when an operational message needs to be sent to the client about something. An example of an operational message would be notifying the client as to which files have been deleted in a long running delete process so that the client can update the UI. Care should be taken not to overuse this function as it can slow down the progress of the provider. A client can optionally register to receive these messages via an asynchronous callback. If a client does not register for these messages, the server will ignore the message.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Redistributable

Windows Management Framework 3.0 on Windows Server 2008 R2 with SP1, Windows 7 with SP1, and Windows Server 2008 with SP2

Header

Mi.h

See also

MI_Context

 

 

Show:
© 2014 Microsoft