IRemoteDesktopClientActions::GetSnapshot method

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps | Metro style apps

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

snapshotEncoding [in]

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

snapshotFormat [in]

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

snapshotWidth [in]

The width, in pixels, of the snapshot.

snapshotHeight [in]

The height, in pixels, of the snapshot.

snapshotData [out, retval]

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

Return value

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

Requirements

See also

IRemoteDesktopClientActions

Send comments about this topic to Microsoft

Build date: 4/21/2012