Edit

Share via

MI_DestinationOptions_GetOption function (mi.h)

  • Article

Gets a previously added option value based on the option name.

Syntax

MI_INLINE MI_Result MI_DestinationOptions_GetOption(
  [in]            MI_DestinationOptions *options,
                  const MI_Char         *optionName,
  [out]           MI_Value              *value,
  [out]           MI_Type               *type,
  [out, optional] MI_Uint32             *index,
  [out, optional] MI_Uint32             *flags
);

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] value

The returned option value. This value is owned by the destination options object, so there is no need to delete it.

[out] type

Returned option type.

[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

Requirement Value
Minimum supported client Windows 8
Minimum supported server Windows Server 2012
Target Platform Windows
Header mi.h
Redistributable Windows Management Framework 3.0 on Windows Server 2008 R2 with SP1, Windows 7 with SP1, and Windows Server 2008 with SP2