Skip to main content

Windows Dev Center

MI_DestinationOptions_GetString function

Gets a previously added custom string option.

Syntax


 MI_INLINE MI_Result MI_DestinationOptions_GetString(
  _In_      MI_DestinationOptions           *options,
            _In_z_ const MI_Char            *optionName,
            _Outptr_result_z_ const MI_Char **optionValue,
  _Out_opt_ MI_Uint32                       *index
);

Parameters

options [in]

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.

index [out, optional]

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.

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

See also

MI_DestinationOptions
MI_Application_NewDestinationOptions
MI_DestinationOptions_SetString