Windows Dev Center

Expand Minimize

MI_DestinationOptions_SetString function

Sets a custom string option.

Syntax


 MI_INLINE MI_Result MI_DestinationOptions_SetString(
  _Inout_ MI_DestinationOptions *options,
          _In_z_ const MI_Char  *optionName,
          _In_z_ const MI_Char  *optionValue
);

Parameters

options [in, out]

A pointer to a MI_DestinationOptions object returned from the MI_Application_NewDestinationOptions function.

optionName

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

optionValue

A null-terminated string that represents the new value 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.

Return codeDescription
MI_RESULT_OK

The operation succeeded.

MI_RESULT_SERVER_LIMITS_EXCEEDED

There is not enough memory to complete the request.

MI_RESULT_INVALID_PARAMETER

One or more parameters passed to the function were not valid.

MI_RESULT_FAILED

A failure not covered by other MI_Result error codes.

 

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Redistributable

Windows Management Framework 3.0 on Windows Server 2008 R2 with SP1, Windows 7 with SP1, and Windows Server 2008 with SP2

Header

Mi.h

See also

MI_DestinationOptions
MI_Application_NewDestinationOptions
MI_DestinationOptions_GetString

 

 

Show:
© 2015 Microsoft