MI_DestinationOptions_GetString function (mi.h)
Gets a previously added custom string option.
Syntax
MI_INLINE MI_Result MI_DestinationOptions_GetString(
[in] MI_DestinationOptions *options,
const MI_Char *optionName,
const MI_Char **optionValue,
[out, optional] MI_Uint32 *index
);
Parameters
[in] options
MI_DestinationOptions object returned from MI_Application_NewDestinationOptions.
optionName
A null-terminated string that represents the name of the option to get.
optionValue
A pointer to a null-terminated string containing the returned option value. This value is owned by the options parameter, so it does not need to be deleted.
[out, optional] index
Returned zero-based index of value.
Return value
A value of the MI_Result enumeration that specifies the function return code. This can be one of the following codes.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 8 |
| Minimum supported server | Windows Server 2012 |
| Target Platform | Windows |
| Header | mi.h |
| Redistributable | Windows Management Framework 3.0 on Windows Server 2008 R2 with SP1, Windows 7 with SP1, and Windows Server 2008 with SP2 |