MI_DestinationOptions_GetOptionAt function
Gets a previously added option value based on the specified index.
Syntax
MI_Result MI_DestinationOptions_GetOptionAt( _In_ MI_DestinationOptions *options, MI_Uint32 index, _Outptr_result_z_ const MI_Char **optionName, _Out_ MI_Value *value, _Out_ MI_Type *type, _Out_opt_ MI_Uint32 *flags );
Parameters
- options [in]
-
MI_DestinationOptions object returned from MI_Application_NewDestinationOptions.
- index
-
Zero-based index of the option.
- optionName
-
A pointer to a null-terminated string containing the returned option name.
- value [out]
-
Returned option value. This value is owned by the destination options object, so there is no need to delete it.
- type [out]
-
Returned option type.
- flags [out, optional]
-
Returned flags.
Return value
A value of the MI_Result enumeration that specifies the function return code. This can be one of the following codes.
| Return code | Description |
|---|---|
|
The operation succeeded. |
|
There is not enough memory to complete the request. |
|
One or more parameters passed to the function were not valid. |
|
A failure not covered by other MI_Result error codes. |
Requirements
|
Minimum supported client | Windows 8 [desktop apps only] |
|---|---|
|
Minimum supported server | Windows Server 2012 [desktop apps only] |
|
Redistributable | Windows Management Framework 3.0 on Windows Server 2008 R2 with SP1, Windows 7 with SP1, and Windows Server 2008 with SP2 |
|
Header |
|
Build date: 12/6/2012