IMsTscAdvancedSettings::ContainerHandledFullScreen property

Article
12/11/2020

Specifies whether the container-handled full-screen mode is enabled.

Note

The value of the ContainerHandledFullScreen property has no effect when the Remote Desktop ActiveX control is safe for scripting, and returns S_FALSE when an attempt is made to change the value.

This property is read/write.

Syntax

HRESULT put_ContainerHandledFullScreen(
  [in]  BOOL ContainerHandledFullScreen
);

HRESULT get_ContainerHandledFullScreen(
  [out] BOOL *pContainerHandledFullScreen
);

Property value

Set this parameter to TRUE to enable the mode or another value to disable the mode.

Error codes

Returns S_OK if successful. Returns S_FALSE if not supported.

Remarks

When this mode is enabled, the current container processes the switch into and out of full-screen mode. This method should be used only if the current container needs extensive control over full-screen mode behavior. When this property is set, the control does not enter or leave full-screen mode in response to the full-screen mode shortcut key combination (CTRL+ALT+BREAK); instead, the IMsTscAxEvents::OnRequestGoFullScreen and IMsTscAxEvents::OnRequestLeaveFullScreen events are called. See IMsTscAxEvents for more information about these events.

Most container applications will not need to use container-handled full-screen mode.

For more information about Remote Desktop Web Connection, see Requirements for Remote Desktop Web Connection.

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Type library	MsTscAx.dll
DLL	MsTscAx.dll
IID	IID_IMsTscAdvancedSettings is defined as 809945cc-4b3b-4a92-a6b0-dbf9b5f2ef2d