IMsTscAxEvents::OnConfirmClose

This method is called when the client calls the IMsRdpClient::RequestClose method, specifying that the user should be prompted to confirm closing the connection.

VOID OnConfirmClose(
  VARIANT_BOOL* pfAllowClose
);

Parameters

  • pfAllowClose
    [out] VARIANT_TRUE, the default, indicates the user wants to close the connection. VARIANT_FALSE indicates the user does not want to close the connection.

Return Values

None.

Remarks

When a container application calls IMsRdpClient::RequestClose, that method returns a value indicating whether the container should wait for an OnConfirmClose event to occur before closing the control connection. If RequestClose returns controlCloseWaitForEvents, and the user is connected and logged on to their Terminal Services session, the OnConfirmClose event is initiated. At that point the container application can prompt the user, asking whether the user wants to close the connection. If the user wants to close the connection, the application should set the pfAllowClose parameter to VARIANT_TRUE and proceed with closing the connection. If the user does not want to close, the application should set pfAllowClose to VARIANT_FALSE and leave the connection open.

Requirements

OS Versions: Windows CE .NET 4.0 and later.
Header: Discodlg.h. Mstsax.idl.
Link Library: Mstsax.lib.

See Also

IMsTscAxEvents

 Last updated on Saturday, April 10, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.