Edit

Share via

IPackageDebugSettings::EnumerateBackgroundTasks method (shobjidl_core.h)

  • Article

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

Syntax

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

Parameters

[in] packageFullName

The package full name to query for background tasks.

[out] taskCount

The count of taskIds and taskNames entries.

[out] taskIds

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

[out] taskNames

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

Requirement Value
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Target Platform Windows
Header shobjidl_core.h

See also

IPackageDebugSettings