BackgroundTransferRequest.Tag Property
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Gets or sets additional data associated with the request.
Namespace: Microsoft.Phone.BackgroundTransfer
Assembly: Microsoft.Phone (in Microsoft.Phone.dll)
XMLNS for XAML: Not mapped to an xmlns.
Syntax
Public Property Tag As String
public string Tag { get; set; }
<object Tag="string" .../>
Property Value
Type: System..::.String
Additional data associated with the request.
Remarks
This property can be used to associate custom data associated with a transfer. The application can set the value when the transfer request is created. When the transfer request is retrieved, using the Requests property or the Find(String) method, the Tag property will contain the previously set data. This property is only used by the calling application and is ignored by the system. The maximum length of this property is 4000 characters, but it is recommended that you keep the size of the data smaller in order to improve performance.
This method may throw one of the following exceptions.
InvalidOperationException |
A transfer request’s properties cannot be modified after it has been submitted or disposed. |
Version Information
Windows Phone OS
Supported in: 8.1, 8.0, 7.1
Platforms
Windows Phone