msSiteModeCreateJumpList method

Article
05/02/2017

Creates a new group of items on the Jump List.

This method is not supported for Windows apps using JavaScript.

Syntax

HRESULT retVal = object.msSiteModeCreateJumpList(bstrHeader);

Parameters

bstrHeader [in]
Type: BSTR

A BSTR that specifies a title for the Jump List group.

Return value

Type: HRESULT

This method can return one of these values.

Return code	Description
S_OK	The operation completed successfully.
E_NOTIMPL	This method is not supported on Windows CE.

Standards information

There are no standards that apply here.

Remarks

A Jump List contains links into your application and elsewhere. The pinned site allows only one Jump List group at a time, and all items are appended to the same list. (For more information, see IShellUIHelper4::msSiteModeAddJumpListItem.)

You create a new Jump List group by calling the IShellUIHelper4::msSiteModeCreateJumpList method followed by IShellUIHelper4::msSiteModeAddJumpListItem and IShellUIHelper4::msSiteModeShowJumpList. The list is cleared only if the name provided in the bstrHeader parameter is different from the current list. If necessary, you can call IShellUIHelper4::msSiteModeClearJumpList to start a new list; however, doing so prevents the HTMLDocumentEvents4::onmssitemodejumplistitemremoved event from being raised.

To view the Jump List, hover over the pinned site shortcut after pinning it to the Start menu, or right-click the pinned site button in the Windows taskbar.

Share via