FMX.Clipboard.IFMXExtendedClipboardService.UnregisterCustomFormat

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure UnregisterCustomFormat(const AFormatName: string);

C++

virtual void __fastcall UnregisterCustomFormat(const System::UnicodeString AFormatName) = 0 ;

Properties

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

Description

Unregisters the specified custom format identifier.

Exceptions

UnregisterCustomFormat may raise one of the following exceptions:

Exception Message Scenarios

EArgumentException

AFormat parameter cannot be empty

  • The specified custom format identifier, AFormatName, is an empty string. You must specify a registered custom format identifier.

EClipboardFormatNotRegistered

Custom clipboard format with name "<AFormatName>" is not registered

  • The specified custom format identifier, AFormatName, is not registered. Use IsCustomFormatRegistered to check whether a given custom format identifier is already registered or not before you attempt to unregister it.

See Also