Vcl.JumpList.TCustomJumpList.DeleteList

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function DeleteList: Boolean;

C++

bool __fastcall DeleteList(void);

Properties

Type Visibility Source Unit Parent
function public
Vcl.JumpList.pas
Vcl.JumpList.hpp
Vcl.JumpList TCustomJumpList

Description

Removes any content that your application defined for its jump list, and returns True if the removal succeeds or False otherwise.

DeleteList removes from the jump list of your application any configuration that your application defined using the jump lists component. That includes:

Note: DeleteList does not remove any data from the jump list component, only from the actual jump list. If you call UpdateList right after you call DeleteList, the combination of both calls has no effect.

Exceptions

A call to DeleteList may raise any of the following exceptions:

Exception Exception.Message Scenarios

EJumpListException

JumpList exception: Error <code> Beginning List

JumpList exception: Error <code> Committing List

See Also