MI_OperationOptions_GetString function (mi.h)

Gets a custom string option.

Syntax

MI_INLINE MI_Result MI_OperationOptions_GetString(
  [in]            MI_OperationOptions *options,
                  const MI_Char       *optionName,
                  const MI_Char       **value,
  [out, optional] MI_Uint32           *index,
  [out, optional] MI_Uint32           *flags
);

Parameters

[in] options

MI_OperationOptions structure.

optionName

A null-terminated string that represents the name of the option.

value

Returned option value.

[out, optional] index

Returned zero-based index of the option.

[out, optional] flags

Returned option flags.

Return value

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

Requirements

See also

MI_OperationOptions_SetString