Vcl.JumpList.TCustomJumpList.UpdateList

• Up to Parent: TCustomJumpList

Delphi

function UpdateList: Boolean;

C++

bool __fastcall UpdateList();

Properties

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

Description

Updates the jump list of your application to show the information defined in your jump list component.

UpdateList returns True if the update succeeds, or False otherwise.

Alternatively, you can enable the AutoRefresh property to have any changes to the jump list component synchronized with the jump list of your application.

Exceptions

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

Exception	Exception.Message	Scenarios
EJumpListException	JumpList exception: Error <code> Beginning List	ICustomDestinationList::BeginList returned an error code, and you either did not handle the OnListUpdateError event or your event handler did not mark the error as handled.
	JumpList exception: Error <code> Committing List	ICustomDestinationList::CommitList returned an error code, and you either did not handle the OnListUpdateError event or your event handler did not mark the error as handled.
EJumpListItemException	JumpListItem exception: Error <code> Appending Recent Category	ShowRecent is True and ICustomDestinationList::AppendKnownCategory returned an error code.
	JumpListItem exception: Error <code> Appending Frequent Category	ShowFrequent is True and ICustomDestinationList::AppendKnownCategory returned an error code.
	JumpListItem exception: Error <code> Adding User tasks	You have defined one or more tasks and, adding one of those tasks to the jump list of your application, ICustomDestinationList::AddUserTasks returned an error code.
	JumpListItem exception: Error <code> Adding Category <name>	You have defined one or more custom categories and, adding one of those categories to the jump list of your application, ICustomDestinationList::AppendCategory returned an error code.

The implementation of UpdateList uses the following members that may raise their own exceptions:

• GetObjectArray
• GetAsIShellLink

See Also

• System.Boolean

• Vcl.JumpList.TCustomJumpList.DeleteList

• Vcl.JumpList.TCustomJumpList.TaskList
• Vcl.JumpList.TCustomJumpList.CustomCategories
• Vcl.JumpList.TCustomJumpList.AutoRefresh

• Vcl.JumpList.TCustomJumpList.ShowFrequent
• Vcl.JumpList.TCustomJumpList.ShowRecent

• Vcl.JumpList.TCustomJumpList.OnItemDeleted
• Vcl.JumpList.TCustomJumpList.OnListUpdateError