BackgroundTransferGroup.CreateGroup(String) Method

Definition

Creates a transfer group using the provided group name.

public:
 static BackgroundTransferGroup ^ CreateGroup(Platform::String ^ name);
 static BackgroundTransferGroup CreateGroup(winrt::hstring const& name);
public static BackgroundTransferGroup CreateGroup(string name);
function createGroup(name)
Public Shared Function CreateGroup (name As String) As BackgroundTransferGroup

Parameters

name
String

The name of the group. If a group with the this name already exists, this method will return a reference to the existing group object.

Returns

BackgroundTransferGroup

The new BackgroundTransferGroup.

Remarks

A BackgroundTransferGroup object can persist to support transfer operations that span app sessions. New methods have been introduced to BackgroundDownloader, BackgroundUploader, DownloadOperation, and UploadOperation to simplify accessing groups created in a previous app session.

Note

Windows 8.1 and Windows Server 2012 R2 support a maximum of 50 unique transfer groups for the entire system. So an app should reuse a unique ID or a small number of unique IDs for all transfer groups created by the app. If more than 50 transfer groups are created on the system, the app will get in an unrecoverable state.

Applies to