MI_OperationOptionsFT structure

A support structure used in the MI_OperationOptions structure. Use the functions with the name prefix "MI_OperationOptions_" to manipulate these structures.

Syntax


typedef struct _MI_OperationOptionsFT {
  MI_Result (MI_CALL *Delete)(_Inout_ MI_OperationOptions *options);
  MI_Result (MI_CALL *SetString)(
      _Inout_ MI_OperationOptions *options, 
      _In_ const MI_Char *optionName, 
      _In_ const MI_Char *value, 
      MI_Uint32 flags);
  MI_Result (MI_CALL *SetNumber)(
      _Inout_ MI_OperationOptions *options, 
      _In_ const MI_Char *optionName, 
      _In_ MI_Uint32 value, 
      MI_Uint32 flags);
  MI_Result (MI_CALL *SetCustomOption)(
      _Inout_ MI_OperationOptions *options, 
      _In_ const MI_Char *optionName, 
      _In_ MI_Type valueType, 
      _In_ const MI_Value *value, 
      MI_Boolean mustComply, 
      MI_Uint32 flags);
  MI_Result (MI_CALL *GetString)(
      _In_ MI_OperationOptions *options, 
      _In_ const MI_Char *optionName, 
      _Out_ const MI_Char **value, 
      _Out_opt_ MI_Uint32 *index, 
      _Out_opt_ MI_Uint32 *flags);
  MI_Result (MI_CALL *GetNumber)(
      _In_ MI_OperationOptions *options, 
      _In_ const MI_Char *optionName, 
      _Out_ MI_Uint32 *value, 
      _Out_opt_ MI_Uint32 *index, 
      _Out_opt_ MI_Uint32 *flags);
  MI_Result (MI_CALL *GetOptionCount)(
      _In_ MI_OperationOptions *options, 
      _Out_ MI_Uint32 *count);
  MI_Result (MI_CALL *GetOptionAt)(
      _In_ MI_OperationOptions *options, 
      MI_Uint32 index, 
      _Out_ const MI_Char **optionName, 
      _Out_ const MI_Value *value, 
      _Out_ MI_Type *type, 
      _Out_opt_ MI_Uint32 *flags);
  MI_Result (MI_CALL *GetOption)(
      _In_ MI_OperationOptions *options, 
      _In_ const MI_Char *optionName, 
      _Out_ const MI_Value *value, 
      _Out_ MI_Type *type, 
      _Out_opt_ MI_Uint32 *index, 
      _Out_opt_ MI_Uint32 *flags);
  MI_Result (MI_CALL *GetEnabledChannels)(
      _In_ MI_OperationOptions *options, 
      _In_ const MI_Char *optionName, 
      _Out_opt_ MI_Uint32 *channels, 
      _In_ MI_Uint32 *bufferLength, 
      _Out_ MI_Uint32 *channelCount, 
      _Out_opt_ MI_Uint32 *flags);
  MI_Result (MI_CALL *Clone)(
      _In_ const MI_OperationOptions *self, 
      _Out_ MI_OperationOptions *newOperationOptions);
} MI_OperationOptionsFT;

Members

Delete

Deletes an option and its associated memory. See MI_OperationOptions_Delete.

SetString

Sets a custom string option. See MI_OperationOptions_SetString.

SetNumber

Sets a custom number option value. See MI_OperationOptions_SetNumber.

SetCustomOption

Sets a custom option for the operation. See MI_OperationOptions_SetCustomOption.

GetString

Gets a custom string option. See MI_OperationOptions_GetString.

GetNumber

Gets a previously added custom number option. See MI_OperationOptions_GetNumber.

GetOptionCount

Gets the number of options previously added. See MI_OperationOptions_GetOptionCount.

GetOptionAt

Gets a previously added option value based on the specified index. See MI_OperationOptions_GetOptionAt.

GetOption

Gets a previously added option value based on the option name. See MI_OperationOptions_GetOption.

GetEnabledChannels

See MI_OperationOptions_GetEnabledChannels.

Clone

Creates a copy of a MI_OperationOptions structure. See MI_OperationOptions_Clone.

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: