MI_Session_TestConnection function (mi.h)

Tests a connection by communicating with the server represented by the session to determine whether it is responding.

Syntax

MI_INLINE void MI_Session_TestConnection(
  [in]           MI_Session            *session,
                 MI_Uint32             flags,
  [in, optional] MI_OperationCallbacks *callbacks,
  [out]          MI_Operation          *operation
);

Parameters

[in] session

Session handle returned from MI_Application_NewSession.

flags

Must be 0.

[in, optional] callbacks

Optional MI_OperationCallbacks structure that defines the operational callbacks to receive the instance result and CIM semantics. To carry out the operation asynchronously, the structure's instanceResult callback member must be specified. If this member is not specified, the client must call the MI_Operation_GetInstance function to retrieve the results.

[out] operation

Returned operation handle that must be closed via MI_Operation_Close once complete. Calling MI_Operation_Cancel before it is complete will cause the operation to shutdown. MI_Operation_Close and MI_Operation_Cancel can be called from any operation.

Return value

None

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

See also

MI_Application_NewSession

MI_OperationCallbacks

MI_Operation_Cancel

MI_Operation_Close

MI_Operation_GetInstance