Expand Minimize

MI_Context_SetStringOption function

Sets a context-specific option.

Syntax


MI_Result MI_Context_SetStringOption(
  _In_  MI_Context *context,
  _In_z_ const MI_Char *name,
  _In_z_ const MI_Char *value
);

Parameters

context [in]

Request context.

name

A null-terminated string that represents the name of the option to change.

value

A null-terminated string that represents the new value for the specified option.

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

This function allows the provider to adjust the server's behavior.

On Windows Server 2012, this function only supports the "SECURITY" option, which is used only by an indication provider to control which users have permission to subscribe to the indication class. The function is valid if and only if it is called inside the indication class's *_Load function.

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_Context
MI_Context_GetCustomOption
MI_Context_GetCustomOptionAt
MI_Context_GetCustomOptionCount
MI_Context_GetNumberOption
MI_Context_GetStringOption

 

 

Show:
© 2014 Microsoft. All rights reserved.