DkmTransportConnection.ActivateBackgroundTask Method
Definition
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.
Activate an background task. This is used by developers to test their app's activate handler.
This method will append a new work item to the specified work list, and return once the work item has been appended. The actual processing of the work item is asynchronous. The caller will be notified that the request is complete through the completion routine.
public:
void ActivateBackgroundTask(Microsoft::VisualStudio::Debugger::DkmWorkList ^ WorkList, Microsoft::VisualStudio::Debugger::DefaultPort::DkmAppPackageId ^ AppPackageId, int SessionId, Guid TaskId, Microsoft::VisualStudio::Debugger::DkmCompletionRoutine<Microsoft::VisualStudio::Debugger::DefaultPort::DkmActivateBackgroundTaskAsyncResult> ^ CompletionRoutine);public void ActivateBackgroundTask (Microsoft.VisualStudio.Debugger.DkmWorkList WorkList, Microsoft.VisualStudio.Debugger.DefaultPort.DkmAppPackageId AppPackageId, int SessionId, Guid TaskId, Microsoft.VisualStudio.Debugger.DkmCompletionRoutine<Microsoft.VisualStudio.Debugger.DefaultPort.DkmActivateBackgroundTaskAsyncResult> CompletionRoutine);member this.ActivateBackgroundTask : Microsoft.VisualStudio.Debugger.DkmWorkList * Microsoft.VisualStudio.Debugger.DefaultPort.DkmAppPackageId * int * Guid * Microsoft.VisualStudio.Debugger.DkmCompletionRoutine<Microsoft.VisualStudio.Debugger.DefaultPort.DkmActivateBackgroundTaskAsyncResult> -> unitPublic Sub ActivateBackgroundTask (WorkList As DkmWorkList, AppPackageId As DkmAppPackageId, SessionId As Integer, TaskId As Guid, CompletionRoutine As DkmCompletionRoutine(Of DkmActivateBackgroundTaskAsyncResult))Parameters
- WorkList
- DkmWorkList
WorkList to append the new work item to.
- AppPackageId
- DkmAppPackageId
[In] Identifies a Windows Store app package or Windows Phone app package.
- SessionId
- Int32
[In] The id of the session where the application is running.
- TaskId
- Guid
[In] Activating task id (GUID).
- CompletionRoutine
- DkmCompletionRoutine<DkmActivateBackgroundTaskAsyncResult>
Routine to fire when the request is complete. If the request is successfully appended to the work list, this will always fire (including when the operation is canceled). This will never fire if appending the work item fails.