MI_DestinationOptions_GetNumber function (mi.h)

Gets a previously added custom number option.

Syntax

MI_INLINE MI_Result MI_DestinationOptions_GetNumber(
  [in]            MI_DestinationOptions *options,
                  const MI_Char         *optionName,
  [out]           MI_Uint32             *optionValue,
  [out, optional] MI_Uint32             *index
);

Parameters

[in] options

MI_DestinationOptions object returned from MI_Application_NewDestinationOptions.

optionName

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

[out] optionValue

Returned option value.

[out, optional] index

Returned zero-based index of the option.

Return value

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

Requirements