Show: Delphi C++
Display Preferences

FMX.Clipboard.IFMXExtendedClipboardService.GetCustomFormat

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function GetCustomFormat(const AFormatName: string; const AStream: TStream): Boolean;

C++

virtual bool __fastcall GetCustomFormat(const System::UnicodeString AFormatName, System::Classes::TStream* const AStream) = 0 ;

Properties

Type Visibility Source Unit Parent
function public
FMX.Clipboard.pas
FMX.Clipboard.hpp
FMX.Clipboard IFMXExtendedClipboardService

Description

Fills the specified data stream with the content of the system clipboard and returns True on success or False otherwise.

If the content of the system clipboard is not in the specified custom format, GetCustomFormat returns False and the specified data stream is not modified. Otherwise, GetCustomFormat returns True.

Exceptions

GetCustomFormat may raise one of the following exceptions:

Exception Message Scenarios

EArgumentException

AFormat parameter cannot be empty

EArgumentNilException

AStream parameter cannot be nil

  • The specified data stream, AStream, is nil. You must specify an instance of TStream.

EClipboardFormatNotRegistered

<AFormatName>

  • The specified custom format identifier, AFormatName, has not been registered. You must register any custom format identifier before you use it.

ENotSupportedException

JClipboardManager does not support custom data

See Also

Personal tools
In Other Languages
Previous Versions
Assistance