Activity::GetActivityDescription method

Returns the activity description of the Activity.

Syntax

virtual HRESULT GetActivityDescription(
  [out] LPCWSTR *activityDescription
) const = 0;

Parameters

activityDescription [out]

The activity description.

Return value

If the function succeeds, it returns S_OK. If it fails, it returns an error value.

Remarks

Activity objects hold data from Iteration/Activities/Activity elements.

The activity description is the value of element Activity/ActivityDescription.

Requirements

Minimum supported client	Windows 7 [desktop apps only]
Minimum supported server	Windows Server 2008 R2 [desktop apps only]
Header	AxeRuntime.h
DLL	AxeCore.dll

See also

Activity