Expand Minimize

MI_Context_WriteVerbose function

Writes a verbose message to the client.

Syntax


 MI_INLINE MI_Result MI_Context_WriteVerbose(
  _In_  MI_Context *context,
  _In_z_ const MI_Char *message
);

Parameters

context [in]

Request context.

message

A null-terminated string that represents the message to be sent to the client. This string should be localized.

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 a verbose message needs to be sent to the client. A verbose message indicates any progress a provider may be making or useful information that a client may need while running an operation. 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

 

 

Show:
© 2014 Microsoft