IPackageDebugSettings::EnumerateBackgroundTasks method

Gets the background tasks that are provided by the specified package.

Syntax


HRESULT EnumerateBackgroundTasks(
  [in]                        LPCWSTR packageFullName,
  [out]                       ULONG   *taskCount,
  [out, size_is(,*taskCount)] LPCGUID *taskIds,
  [out, size_is(,*taskCount)] LPCWSTR **taskNames
);

Parameters

packageFullName [in]

The package full name to query for background tasks.

taskCount [out]

The count of taskIds and taskNames entries.

taskIds [out]

An array of background task identifiers. You can use these identifiers in the ActivateBackgroundTask method to activate specified tasks.

taskNames [out]

An array of task names that corresponds with background taskIds.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

Both parameters taskIds and taskNames have the same ordering of tasks. If you need to know the user-readable task name associated with taskId[0], refer to taskNames[0].

Requirements

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

Shobjidl.h

IDL

Shobjidl.idl

See also

IPackageDebugSettings

 

 

Show: