IRDPSRAPIClipboardUseEvents::OnPasteFromClipboard method (rdpencomapi.h)

  • Article

This callback is issued when an attempt to copy data from the sharer computer is made.

Syntax

HRESULT OnPasteFromClipboard(
  [in]          UINT         clipboardFormat,
  [in]          IDispatch    *pAttendee,
  [out, retval] VARIANT_BOOL *pRetVal
);

Parameters

[in] clipboardFormat

A clipboard format identifier. For more information about clipboard formats, see Clipboard Formats. For a list of clipboard format identifiers, see Standard Clipboard Formats.

[in] pAttendee

A pointer to the IRDPSRAPIAttendee instance for the attendee who attempted the clipboard copy.

[out, retval] pRetVal

The return value for this attempt.

Value Meaning
VARIANT_TRUE
 The clipboard copy attempt should be allowed.
VARIANT_FALSE
 The clipboard copy attempt should not be allowed.

Return value

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

Requirements

Requirement Value
Minimum supported client Windows 10 [desktop apps only]
Minimum supported server Windows Server 2016 [desktop apps only]
Target Platform Windows
Header rdpencomapi.h

See also

IRDPSRAPIClipboardUseEvents

Property