StartScreenManager.TryRemoveSecondaryTileAsync(String) Method

Reference

Definition

Namespace:: Windows.UI.StartScreen

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Tries to remove the specified secondary tile from Start.

public:
 virtual IAsyncOperation<bool> ^ TryRemoveSecondaryTileAsync(Platform::String ^ tileId) = TryRemoveSecondaryTileAsync;

/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<bool> TryRemoveSecondaryTileAsync(winrt::hstring const& tileId);

[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<bool> TryRemoveSecondaryTileAsync(string tileId);

function tryRemoveSecondaryTileAsync(tileId)

Public Function TryRemoveSecondaryTileAsync (tileId As String) As IAsyncOperation(Of Boolean)

Parameters

tileId: String
Platform::String

winrt::hstring

The TileId of the SecondaryTile you want to remove.

Returns

IAsyncOperation<Boolean>

IAsyncOperation<bool>

A boolean representing whether the tile is not on Start. If removing wasn't allowed, this returns false.

Attributes: RemoteAsyncAttribute

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 is only relevant when you are pinning your tiles to multiple surfaces, like pinning secondary tiles to taskbar. If you only pin secondary tiles to Start, you should instead use SecondaryTile.RequestDeleteAsync which has been present since the first version of Windows 10.

Applies to