3.2.5.2.5.3 INtmsSession1::CloseNtmsSession (Opnum 5)

  • Article

The CloseNtmsSession method closes a session.

 HRESULT CloseNtmsSession();

This method has no parameters.

Return value/code

Description

0x00000000

S_OK

The call was successful.

0x800704B1

ERROR_CONNECTION_UNAVAIL

The connection to the server is not available.

This method will close the session. This method MUST be called when the client has dereferenced the session. Note, however, that the server might not yet have dereferenced the session, because one or more interfaces might still be in process. The server, therefore, does not tear down the session, but rather cleans up the session and releases the open session reference, allowing the session to be ended when the last reference is removed.

If the client has an outstanding synchronous request, the requests MUST be unwound and canceled.