TaskbarManager.RequestPinSecondaryTileAsync(SecondaryTile) Method

Definition

Requests to pin the specified tile to taskbar. Requires user approval as described here.

Important

Limited Access API: This API is a limited access feature. To use this API, please contact taskbarsecondarytile@microsoft.com.

public:
 virtual IAsyncOperation<bool> ^ RequestPinSecondaryTileAsync(SecondaryTile ^ secondaryTile) = RequestPinSecondaryTileAsync;
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<bool> RequestPinSecondaryTileAsync(SecondaryTile const& secondaryTile);
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<bool> RequestPinSecondaryTileAsync(SecondaryTile secondaryTile);
function requestPinSecondaryTileAsync(secondaryTile)
Public Function RequestPinSecondaryTileAsync (secondaryTile As SecondaryTile) As IAsyncOperation(Of Boolean)

Parameters

secondaryTile
SecondaryTile

The secondary tile to be pinned.

Returns

IAsyncOperation<Boolean>

IAsyncOperation<bool>

A boolean representing whether the tile is pinned to the takbar. If the tile was already pinned, this will update the tile and return true. If pinning wasn't allowed or taskbar isn't supported, this will return false.

Attributes

Windows requirements

Device family
Windows 10, version 1809 (introduced in 10.0.17763.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v7.0)

Remarks

This API can only be used with user approval, as described here. See the docs for pinning secondary tiles to taskbar to learn more.

Applies to

See also