Expand Minimize

MI_OperationOptions_SetCustomOption function

Sets a custom option for the operation.

Syntax


 MI_INLINE MI_Result MI_OperationOptions_SetCustomOption(
  _Inout_  MI_OperationOptions *options,
  _In_z_ const MI_Char *optionName,
  _In_     MI_Type optionValueType,
  _In_     const MI_Value *optionValue,
  MI_Boolean mustComply
);

Parameters

options [in, out]

A pointer to a MI_OperationOptions structure.

optionName

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

optionValueType [in]

Option type.

optionValue [in]

New option value.

mustComply

Boolean value where MI_TRUE means that the option must be complied with.

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_NOT_FOUND

Specified element does not exist.

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

 

 

Show:
© 2014 Microsoft