MI_Context_GetStringOption function (mi.h)

Gets the string option that the client sets, based on the operation name.

Syntax

MI_INLINE MI_Result MI_INLINE_CALL MI_Context_GetStringOption(
  [in] MI_Context    *context,
  [in] const MI_Char *name,
       const MI_Char **value
);

Parameters

[in] context

A pointer to the request context.

[in] name

The name of the option to get.

value

A pointer to the returned option value.

Return value

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

Remarks

The returned string does not need to be deleted. The string is valid until the provider returns the final result for this operation.

Requirements