IMsRdpAppContainerClientDesktopBitmapAccess::TakeSnapshot method

  • Article

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

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

Syntax

HRESULT TakeSnapshot(
  [in]           SnapshotEncodingType snapshotEncoding,
  [in]           SnapshotFormatType snapshotFormat,
  [in]           ULONG uSnapshotWidth,
  [in]           ULONG uSnapshotHeight,
  [out, retval]  BSTR *ppBitmapDataUri
);

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.

  • uSnapshotWidth [in]
    The width, in pixels, of the snapshot.

  • uSnapshotHeight [in]
    The height, in pixels, of the snapshot.

  • ppBitmapDataUri [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

Minimum supported client

 Windows Developer Preview

Minimum supported server

 Windows Server Developer Preview

IDL

 Rdpappcontainerclient.idl

See also

IMsRdpAppContainerClientDesktopBitmapAccess

SnapshotEncodingType

SnapshotFormatType

 

 

Build date: 9/7/2011