Expand Minimize

MI_Context_GetNumberOption function

Gets the numeric option that the client sets, based on the operation name.

Syntax


MI_Result MI_Context_GetNumberOption(
  _In_       MI_Context *context,
  _In_       const MI_Char *name,
  _Out_opt_  MI_Uint32 *value
);

Parameters

context [in]

A pointer to the request context.

name [in]

The name of the option to get.

value [out, optional]

A pointer to the returned option value. This parameter is optional.

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

 

 

Show:
© 2014 Microsoft