MI_Context_WriteStreamParameter function (mi.h)

Sends streamed parameter data to the client for a method invocation.

Syntax

MI_INLINE MI_Result MI_INLINE_CALL MI_Context_WriteStreamParameter(
  [in] MI_Context     *self,
  [in] const MI_Char  *name,
  [in] const MI_Value *value,
  [in] MI_Type        type,
  [in] MI_Uint32      flags
);

Parameters

[in] self

Request context.

[in] name

A null-terminated string that represents the name of the method parameter to stream.

[in] value

A value-type entity.

[in] type

MI_Type object that indicates the type being streamed.

[in] flags

Must be 0 or MI_FLAG_NULL.

MI_FLAG_NULL (0x20000000)

The end of the stream has been reached.

Return value

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

Remarks

Array-method out parameters can be marked as streamed, which means that instead of sending all out parameters in one chunk they are streamed to the client. Streamed parameter data enables the client to display data in a smoother fashion rather than having to wait until all of the data has been sent. This gives the user interface a smoother, more consistent feel. The value can be an array that contains one or more elements of the specified type. Call this function repeatedly to send the entire stream. If the client does not handle streamed parameters, the server will cache all the results and send them to the client at once. In the case of the results being cached when large result sets are generated, the provider may exceed quotas and be shutdown, meaning that methods that generate very large result sets may work only with clients that support streaming.

Requirements

See also

MI_Context

MI_Type