Expand Minimize

MI_Context_GetCustomOptionAt function

Retrieves an option at a particular index that was set by the client.

Syntax


MI_Result MI_Context_GetCustomOptionAt(
  _In_       MI_Context *context,
  _In_       MI_Uint32 index,
  const _Outptr_opt_result_maybenull_z_ MI_Char **name,
  _Out_opt_  MI_Type *valueType,
  _Out_opt_  const MI_Value *value
);

Parameters

context [in]

A pointer to the request context.

index [in]

The index of the option being retrieved. The index is zero based.

name

A pointer to a pointer to the returned name or the retrieved option.

valueType [out, optional]

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

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.

 

Remarks

Note that the index used does not relate to the order in which the client may have created the options.

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