Edit

Share via

MI_ContextFT structure (mi.h)

  • Article

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

Syntax

typedef struct _MI_ContextFT {
  MI_Result()(MI_Context *context,MI_Result result) * PostResult;
  MI_Result((MI_Context *context, const MI_Instance *instance) * )PostInstance;
  MI_Result(MI_Context *context, const MI_Instance *indication,MI_Uint32 subscriptionIDCount, const MI_Char *bookmark) * )(PostIndication;
  MI_Result(MI_Context *context, const MI_ClassDecl *classDecl,MI_Instance *instance) * )(ConstructInstance;
  MI_Result(MI_Context *context, const MI_MethodDecl *methodDecl,MI_Instance *instance) * )(ConstructParameters;
  MI_Result(I_Context *context, const MI_ClassDecl *classDecl,MI_Instance **instance) * )(MNewInstance;
  MI_Result(I_Context *context, const MI_Char *className,MI_Uint32 flags,MI_Instance **instance) * )(MNewDynamicInstance;
  MI_Result(I_Context *context, const MI_MethodDecl *methodDecl,MI_Instance **instance) * )(MNewParameters;
  MI_Result((const MI_Context *context,MI_Boolean *flag) * )Canceled;
  MI_Result()(const MI_Context *context,MI_LocaleType localeType,MI_Char locale * GetLocale[MI_MAX_LOCALE_SIZE];
  MI_Result((MI_Context *context,MI_CancelCallback callback, void *callbackData) * )RegisterCancel;
  MI_Result()(MI_Context *context) * RequestUnload;
  MI_Result()(MI_Context *context) * RefuseUnload;
  MI_Result((const MI_Context *context,MI_Session *session) * )GetLocalSession;
  MI_Result(MI_Context *context, const MI_Char *name, const MI_Char *value) * )(SetStringOption;
  MI_Result(I_Context *context, const MI_Char *name, const MI_Char **value) * )(MGetStringOption;
  MI_Result(MI_Context *context, const MI_Char *name,MI_Uint32 *value) * )(GetNumberOption;
  MI_Result(I_Context *context, const MI_Char *name,MI_Type *valueType,MI_Value *value) * )(MGetCustomOption;
  MI_Result((MI_Context *context,MI_Uint32 *count) * )GetCustomOptionCount;
  MI_Result(_Context *context,MI_Uint32 index, const MI_Char **name,MI_Type *valueType,MI_Value *value) * )(MIGetCustomOptionAt;
  MI_Result((MI_Context *context,MI_Uint32 channel, const MI_Char *message) * )WriteMessage;
  MI_Result(I_Context *context, const MI_Char *activity, const MI_Char *currentOperation, const MI_Char *statusDescription,MI_Uint32 percentComplete,MI_Uint32 secondsRemaining) * )(MWriteProgress;
  MI_Result(MI_Context *context, const MI_Char *name, const MI_Value *value,MI_Type type,MI_Uint32 flags) * )(WriteStreamParameter;
  MI_Result(MI_Context *context, const MI_Instance *error,MI_Boolean *flag) * )(WriteCimError;
  MI_Result(MI_Context *context, const MI_Char *message,MI_PromptType promptType,MI_Boolean *result) * )(PromptUser;
  MI_Result(I_Context *context, const MI_Char *target, const MI_Char *action,MI_Boolean *result) * )(MShouldProcess;
  MI_Result(MI_Context *context, const MI_Char *message,MI_Boolean *result) * )(ShouldContinue;
  MI_Result(MI_Context *context,MI_Uint32 resultCode, const MI_Char *resultType, const MI_Char *errorMessage) * )(PostError;
  MI_Result((MI_Context *context, const MI_Instance *error) * )PostCimError;
  MI_Result(I_Context *context,MI_Uint32 resultCode, const MI_Char *resultType, const MI_Char *errorMessage,MI_Boolean *flag) * )(MWriteError;
} MI_ContextFT;

Members

PostResult

Providers call this function to post a return code to the server in response to a request. See MI_Context_PostResult.

PostInstance

Providers call this function to post an instance to the server in response to a request. See MI_Context_PostInstance.

PostIndication

Posts an indication to the server in response to a request. See MI_Context_PostIndication.

ConstructInstance

Initializes an instance. See MI_Context_ConstructInstance.

ConstructParameters

Initialize a parameters instance. See MI_Context_ConstructParameters.

NewInstance

Creates a new instance of the class given by the classDecl parameter. See MI_Context_NewInstance.

NewDynamicInstance

Creates a new dynamic instance of the class whose name is given by className. See MI_Context_NewDynamicInstance.

NewParameters

Creates a new instance of the method given by methodDecl. See MI_Context_NewParameters.

Canceled

Determines whether the operation has been canceled. See MI_Context_Canceled.

GetLocale[MI_MAX_LOCALE_SIZE]

Returns the locale of the given type. See MI_Context_GetLocale.

RegisterCancel

Registers a callback that is invoked when the operation is canceled. See MI_Context_RegisterCancel.

RequestUnload

Requests to unload the module or the provider (depending on the location of invocation). See MI_Context_RequestUnload.

RefuseUnload

Tells the provider infrastructure to not unload the provider. See MI_Context_RefuseUnload.

GetLocalSession

Gets the local session allowing the provider to communicate with the CIM server. See MI_Context_GetLocalSession.

SetStringOption

Sets a context-specific option. See MI_Context_SetStringOption.

GetStringOption

Gets the specified provider custom option. See MI_Context_GetStringOption.

GetNumberOption

Gets the specified provider custom option. See MI_Context_GetNumberOption.

GetCustomOption

Gets the specified provider custom option. See MI_Context_GetCustomOption.

GetCustomOptionCount

Gets the count of defined provider custom options. See MI_Context_GetCustomOptionCount.

GetCustomOptionAt

Gets the provider's custom option at the specified index. See MI_Context_GetCustomOptionAt.

WriteMessage

Sends an operational message to the client. See MI_Context_WriteMessage.

WriteProgress

Sends a progress message to the client. See MI_Context_WriteProgress.

WriteStreamParameter

Sends streamed parameter data to the requestor. See MI_Context_WriteStreamParameter.

WriteCimError

Sends a CIM error instance to the client. See MI_Context_WriteCimError.

PromptUser

Sends a prompt message to the client querying whether to continue the operation or cancel it. See MI_Context_PromptUser.

ShouldProcess

Queries the client to determine if an operation should continue. See MI_Context_ShouldProcess.

ShouldContinue

Queries the client to determine if an operation should continue. See MI_Context_ShouldContinue.

PostError

Providers call this function to post a return code to the client in response to a request. See MI_Context_PostError.

PostCimError

Posts a return code and an error message to the server in response to a request. See MI_Context_PostCimError.

WriteError

This function has been deprecated. Use MI_Context_WriteError instead.

Sends an error code and error message to the client. See MI_Context_WriteError.

Requirements

Requirement Value
Minimum supported client Windows 8
Minimum supported server Windows Server 2012
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