RemoteDesktopClientActions::GetSnapshot method

[GetSnapshot is no longer available for use as of Windows 10 and Windows Server 2016 Technical Preview.]

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

Syntax

getSnapshot(snapshotEncoding, snapshotFormat, snapshotWidth, snapshotHeight);

Parameters

• snapshotEncoding [in]
  Type: SnapshotEncodingType**

  A value of the SnapshotEncodingType enumeration that specifies the encoding type for the snapshot.

• snapshotFormat [in]
  Type: SnapshotFormatType**

  A value of the SnapshotFormatType enumeration that specifies the data format type for the snapshot.

• snapshotWidth [in]
  Type: ULONG

  The width, in pixels, of the snapshot.

• snapshotHeight [in]
  Type: ULONG

  The height, in pixels, of the snapshot.

Return value

Type: String

The address of a BSTR variable that receives a data URI that contains the snapshot.

Requirements

See also

RemoteDesktopClientActions