MI_Context_GetCustomOptionAt function (mi.h)

Retrieves an option at a particular index that was set by the client.

Syntax

MI_INLINE MI_Result MI_INLINE_CALL MI_Context_GetCustomOptionAt(
  [in]            MI_Context    *context,
  [in]            MI_Uint32     index,
                  const MI_Char **name,
  [out, optional] MI_Type       *valueType,
  [out, optional] MI_Value      *value
);

Parameters

[in] context

A pointer to the request context.

[in] index

The index of the option being retrieved. The index is zero based.

name

A pointer to a pointer to the returned name or the retrieved option.

[out, optional] valueType

A pointer to the returned option type. This parameter is optional.

[out, optional] value

A pointer to the returned option value. This parameter is optional.

Return value

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

Remarks

Note that the index used does not relate to the order in which the client may have created the options.

Requirements