IRemoteDesktopClientActions::GetSnapshot method (rdpappcontainerclient.h)

Causes a snapshot of the Remote Desktop Protocol (RDP) app container client's in-session desktop to be taken.

Syntax

HRESULT GetSnapshot(
  [in]          SnapshotEncodingType snapshotEncoding,
  [in]          SnapshotFormatType   snapshotFormat,
  [in]          ULONG                snapshotWidth,
  [in]          ULONG                snapshotHeight,
  [out, retval] BSTR                 *snapshotData
);

Parameters

[in] snapshotEncoding

Specifies the encoding type for the snapshot.

[in] snapshotFormat

Specifies the data format type for the snapshot

[in] snapshotWidth

The width, in pixels, of the snapshot.

[in] snapshotHeight

The height, in pixels, of the snapshot.

[out, retval] snapshotData

On return points to the snapshot.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Requirement	Value
Minimum supported client	Windows 8
Minimum supported server	Windows Server 2012
Target Platform	Windows
Header	rdpappcontainerclient.h
DLL	MsTscAx.dll

See also

IRemoteDesktopClientActions